feat: Deploy wiki using gh-pages

Author: nzxl101

.github/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

.github/workflows/build.yml

@@ -0,0 +1,29 @@
+name: Build
+
+on:
+  push:
+    branches-ignore:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - run: python3 -m pip install --upgrade pip
+      - id: pip-cache
+        run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - run: |
+          python3 -m pip install -r requirements.txt
+          mkdocs build

.github/workflows/deploy.yml

@@ -0,0 +1,53 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v5
+
+      - name: Setup Python environment
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+
+      - name: Upgrade pip
+        run: python3 -m pip install --upgrade pip
+
+      - name: Get pip cache directory
+        id: pip-cache
+        run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: python3 -m pip install -r ./requirements.txt
+
+      - name: Build Docs
+        run: mkdocs build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          cname: dockwatch.wiki
+          user_name: Notifiarr
+          user_email: notifiarr+github-actions[bot]@users.noreply.github.com

.gitignore

@@ -0,0 +1 @@
+.venv

README.md

@@ -0,0 +1,35 @@
+# mkdocs-wiki
+
+[Dockwatch wiki](https://dockwatch.wiki) source.
+
+## Local Build
+
+### macOS
+
+```
+brew install python3
+python3 -m venv .venv
+source .venv/bin/activate
+python3 -m pip install -r requirements.txt
+mkdocs serve
+```
+
+### Windows
+
+```
+winget install Python.Python.3.14
+python3 -m venv .venv
+call venv\Scripts\activate
+python3 -m pip install -r requirements.txt
+mkdocs serve
+```
+
+### Linux
+
+```
+sudo apt install python3 || sudo yum install python3
+python3 -m venv .venv
+source .venv/bin/activate
+python3 -m pip install -r requirements.txt
+mkdocs serve
+```

mkdocs.yml

@@ -1,7 +1,7 @@
 site_name: Dockwatch Wiki
 site_author: nitsua
 site_description: Simple UI driven way to manage updates & notifications for Docker containers.
-site_url: http://rm-web-1:8005/en/latest/
+site_url: https://dockwatch.wiki
 repo_name: dockwatch
 repo_url: https://github.com/Notifiarr/dockwatch
 repo_wiki_name: dockwatch-wiki
@@ -21,7 +21,7 @@ nav:
       - Notifications:
         - Notifiarr: pages/notifications/notifiarr.md
         - Telegram: pages/notifications/telegram.md
-      - Settings: 
+      - Settings:
         - General: pages/settings/general.md
         - Logins: pages/settings/logins.md
         - Servers: pages/settings/servers.md

requirements.txt

@@ -0,0 +1,4 @@
+mkdocs~=1.6.0
+mkdocs-material~=9.6.0
+mkdocs-material-extensions~=1.3.0
+mkdocs-glightbox~=0.5.0