Merge pull request #1 from kioydiolabs/move-docs-to-vitepress

Initial move to vitepress
kioydiolabs · May 31, 2024 · 8e024ee · 8e024ee
2 parents e7f0beb + 5d66ca1
commit 8e024ee
Show file tree

Hide file tree

Showing 16 changed files with 1,709 additions and 78 deletions.
diff --git a/Documentation/.vitepress/config.mts b/Documentation/.vitepress/config.mts
@@ -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' }
+    ]
+  }
+})
diff --git a/...rside/topics/Creating-an-Image-gallery.md → Documentation/creating-an-image-gallery.md b/...rside/topics/Creating-an-Image-gallery.md → Documentation/creating-an-image-gallery.md
@@ -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
 

diff --git a/Writerside/images/install_python.png → Documentation/img/install_python.png b/Writerside/images/install_python.png → Documentation/img/install_python.png
diff --git a/Documentation/index.md b/Documentation/index.md
@@ -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!
+---
+
diff --git a/Writerside/topics/Introduction.md → Documentation/introduction.md b/Writerside/topics/Introduction.md → Documentation/introduction.md
@@ -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)
diff --git a/Writerside/topics/linux-prereq.md → Documentation/linux-prereq.md b/Writerside/topics/linux-prereq.md → Documentation/linux-prereq.md
@@ -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!**