Add docs

Author: lulunac27a

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

docs/index.md

@@ -0,0 +1,10 @@
+# Flask Endless User Level XP System
+
+This app is an endless user-based level and XP (experience points). It uses SQlite and SQLAlchemy to store user data in the database.
+
+### Getting Started
+
+1. Clone the repository
+2. Install the requirements: `pip install -r requierements.txt`
+3. Run the app: `python app.py`
+4. Go to `localhost:8081` on your web browser

mkdocs.yml

@@ -0,0 +1,3 @@
+site_name: Flask Endless Level XP System
+theme: material
+repo_url: https://github.com/lulunac27a/flask-endless-level-xp