Add MK Documentation

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: pip install pillow cairosvg
+      - run: mkdocs gh-deploy --force

README.md

@@ -1,15 +1,12 @@
-# EZAuth
+<img src="assets/ezauth_banner.png" />
 
-- Fully Customizable Authentication Service
-- Built on top of FastAPI and MongoDB
+<h3 align="center">High performance self-hosted and fully customizable authentication service</h3>
 
-## Inbuilt E-Mail Templates
+## Disclaimer
 
-### 1. Email Verification
-- Can be enabled in the `config.json` file.
-- Check <a href="./email/ConfirmEmail.md">here</a> for predefined placeholders.
+- ⚠️ The project is under **very active** development.
+- ⚠️ Expect bugs and breaking changes.
+- ⚠️ Make sure to always have a backup of your user data.
 
-### 2. Welcome Email
-- Can be enabled in the `config.json` file.
-- Will be sent out after the user has successfully verified their email address.
-- Check <a href="./email/WelcomeMail.md">here</a> for predefined placeholders.
+> [!NOTE]
+> The Documentation is still in progress.

docs/email.md

@@ -0,0 +1 @@
+# EMAIL Configuration

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -0,0 +1,45 @@
+site_name: EZAuth
+site_description: EZAuth is a high performance self-hosted and fully customizable authentication service
+use_directory_urls: True
+repo_url: https://github.com/JohnGrubba/ezauth
+nav:
+    - Home: index.md
+    - Quickstart with Docker: docker_quickstart.md
+    - Installation:
+        - Linux/MacOS/Raspberry: installation.md
+        - Windows: windows_installation.md
+    - Freqtrade Basics: bot-basics.md
+    - Configuration: configuration.md
+    - Strategy Customization: strategy-customization.md
+    - Strategy Callbacks: strategy-callbacks.md
+    - Stoploss: stoploss.md
+    - Plugins: plugins.md
+    - Start the bot: bot-usage.md
+    - Control the bot:
+        - Telegram: telegram-usage.md
+        - freqUI: freq-ui.md
+        - REST API: rest-api.md
+        - Web Hook: webhook-config.md
+theme:
+  name: material
+  logo: "ezauth_banner.png"
+  features:
+    - content.code.annotate
+    - search.share
+    - content.code.copy
+    - navigation.top
+    - navigation.footer
+  language: en
+  palette:
+    - scheme: default
+      primary: "blue grey"
+      accent: "tear"
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      primary: "blue grey"
+      accent: "tear"
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode