Merge pull request #3 from kioydiolabs/docs-patch-1

Merge docs patch 1
kioydiolabs · May 31, 2024 · a8fa31c · a8fa31c
2 parents 6af1f8d + 361ca7f
commit a8fa31c
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 8 deletions.
diff --git a/Documentation/.vitepress/config.mts b/Documentation/.vitepress/config.mts
@@ -4,7 +4,10 @@ import { defineConfig } from 'vitepress'
 export default defineConfig({
   title: "Imgal Documentation",
   description: "Documentation for Imgal by KioydioLabs",
-  head: [['link', { rel: 'icon', href: '/public/icon.jpg' }]],
+  head: [
+      ['link', { rel: 'icon', href: '/public/icon.jpg' }],
+      ['meta', { name: 'theme-color', content: '#75a300' }]
+    ] ,
   themeConfig: {
     search: {
       provider: 'local'

diff --git a/Documentation/creating-an-image-gallery.md b/Documentation/creating-an-image-gallery.md
@@ -12,6 +12,10 @@ Extract the Imgal zip file.
 
 In a folder, place the `imagal.py` file and the `templates` folder found in the zip file.
 
+::: warning Warning
+**Do not move the `templates` folder or rename or modify the files in any way as this will break Imgal.**
+:::
+
 In the same folder, create another folder, and place your images in it.
 
 ## Creating the image gallery

diff --git a/Documentation/demo.md b/Documentation/demo.md
@@ -6,6 +6,7 @@ hero:
   align: center
   name: "Demo Imgal Galleries"
   text: "Choose a theme"
+  pageClass: demo-page
   actions:
     - theme: brand
       text: Sleek
@@ -21,9 +22,4 @@ hero:
   --vp-home-hero-name-color: transparent;
   --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #75a300, rgb(0,163,149));
 }
-.main{
-    display: flex;
-    flex-direction: column;
-    align-items: center;
-}
 </style>
diff --git a/Documentation/linux-prereq.md b/Documentation/linux-prereq.md
@@ -18,7 +18,9 @@ To do that, open the Terminal and run the following command
 pip install Pillow
 ```
 
-<note>If the command above doesn't work, or you get an error that pip could not be found, run the command below instead</note>
+::: tip Note
+If the command above doesn't work, or you get an error that pip could not be found, run the command below instead
+:::
 
 ```Shell
 python -m install Pillow

diff --git a/Documentation/windows-prereq.md b/Documentation/windows-prereq.md
@@ -18,7 +18,9 @@ To do that, open Powershell and run the following command
 pip install Pillow
 ```
 
-<note>If the command above doesn't work, or you get an error that pip could not be found, run the command below instead</note>
+::: tip Note
+If the command above doesn't work, or you get an error that pip could not be found, run the command below instead
+:::
 
 ```Shell
 python -m install Pillow