Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial move to vitepress #1

Merged
merged 3 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions Documentation/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Imgal Documentation",
description: "Documentation for Imgal by KioydioLabs",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Website', link: 'https://imgal.kioydiolabs.org' }
],

sidebar: [
{
items: [
{ text: 'Introduction', link: '/introduction' },
]
},
{
text: 'Installing Prerequisites',
link: '/prerequisites',
collapsed: true,
items: [
{ text: 'Windows', link: '/windows-prereq' },
{ text: 'Linux', link: '/linux-prereq' },
]
},
{
text: 'Creating an image gallery',
link: '/creating-an-image-gallery'
}
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/kioydiolabs/imgal' }
]
}
})
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Prerequisites

To use Imgal you need Python and the Pillow package installed. Learn how to do that [here](Prerequisites.md).
To use Imgal you need Python and the Pillow package installed. Learn how to do that [here](prerequisites).

### Organizing your files before creating the gallery

Expand Down
25 changes: 25 additions & 0 deletions Documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "Imgal Documentation"
text: "Documentation for Imgal by KioydioLabs"
tagline: The OpenSource Image Library Creator
actions:
- theme: brand
text: Get Started
link: /introduction
- theme: alt
text: View Demo
link: https://imgal-demo.kioydiolabs.org

features:
- title: Choose between cool themes
details: Imgal offers multiple themes to choose from for your image gallery.
- title: Optimized images for the web
details: Imgal resizes images and optimizes them for viewing on the web.
- title: Customize your gallery
details: Imgal galleries are fully customizable, and you can even write your own CSS!
---

Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Imgal is a program for creating photo galleries. It's written in Python.

Imgal is completely opensource and the code can be found on GitHub.

You can find example/demo image libraries created with Imgal at [](https://demo.imgal.kioydiolabs.org).
You can find example/demo image libraries created with Imgal at [imgal-demo.kioydiolabs.org](https://imgal-demo.kioydiolabs.org).

### Creating gallery with Imgal

Learn how to create an image gallery with Imgal
[Learn how to create an image gallery with Imgal](creating-an-image-gallery)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ pip install Pillow
python -m install Pillow
```

**You now have all the prerequisites you need installed! Go back to [Creating an image gallery](Creating-an-Image-gallery.md) to learn how to create a gallery!**
**You now have all the prerequisites you need installed! Go back to [Creating an image gallery](creating-an-image-gallery) to learn how to create a gallery!**
Loading