Merge pull request #39 from SkwalExe/documentation

Add first documentation page

docs/.vitepress/config.mts

@@ -12,6 +12,7 @@ export default defineConfig({
             { text: "Home", link: "/" },
             { text: "Getting Started", link: "/getting-started" },
         ],
+        outline: 'deep',
         footer: {
             message: 'Released under the GNU General Public License (GPLv3).',
             copyright: 'Copyright © 2021-present Léopold Koprivnik'
@@ -24,10 +25,10 @@ export default defineConfig({
         },
         sidebar: [
             {
-                text: "Examples",
+                text: "Introduction",
                 items: [
-                    { text: "Markdown Examples", link: "/markdown-examples" },
-                    { text: "Runtime API Examples", link: "/api-examples" },
+                    { text: "📥 Getting Started", link: "/getting-started" },
+                    { text: "🎨 Available Styles/Temes", link: "/available-styles" },
                 ],
             },
         ],

docs/.vitepress/theme/custom.css

@@ -2,5 +2,5 @@
   --vp-c-brand-1: #ee8483;
   --vp-c-brand-2: #e75351;
   --vp-c-brand-3: #ee8483;
-  --vp-c-brand-soft: #f5b5b4;
+  /* --vp-c-brand-soft: #f5b5b4; */
 }

docs/src/available-styles.md

@@ -0,0 +1,3 @@
+::: warning WORK IN PROGRESS
+The documentation will be completed soon.
+:::

docs/src/getting-started.md

@@ -1,3 +1,41 @@
-::: warning
-Work in progress. The documentation will be available soon.
+![Project's logo](./logo.png)
+
+<p align="center">💠 Simple logos for complex projects 💠</p>
+
+## Credits 
+
+I had the idea to create this project after seeing the logos made by [adi1090x](https://github.com/adi1090x) for his repositories. They were simple but gave a nice feel to his projects. I wanted a logo that gives the same energy, but didn't manage to find how he made them (most likely manually, with GIMP according the the exif data of the images). So I decided to make a program that would allow anyone to generate cool and simple logos for their projects.
+
+## Installation 📥 {#installation}
+
+OctoLogo requires Python version 3.9 or higher.
+
+::: warning Command not found
+
+If the command is not found after installation, it may be because the `~/.local/bin` directory is not in your path. You can fix this probem by adding `export PATH=$PATH:~/.local/bin` to your `.bashrc` or `.zshrc` file.
+
+```bash
+# For bash
+echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
+
+# For zsh
+echo 'export PATH=$PATH:~/.local/bin' >> ~/.zshrc
+```
 :::
+
+
+### Via pipx (recommended)
+
+```bash
+pipx install octologo
+```
+
+### Via pip
+
+```bash
+pip install octologo
+```
+
+---
+
+**🎉 You can now use the app with the `octologo` command!**