From b1c303c2984b0a14c60df9a8bc5b31a4671a5106 Mon Sep 17 00:00:00 2001
From: grimsi <9295182+grimsi@users.noreply.github.com>
Date: Fri, 30 May 2025 22:04:20 +0200
Subject: [PATCH] Add MkDocs

---
 .github/workflows/docs.yml | 30 ++++++++++++++++++++++++++
 docs/assets/logo.svg       |  1 +
 docs/index.md              | 17 +++++++++++++++
 mkdocs.yml                 | 44 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 92 insertions(+)
 create mode 100644 .github/workflows/docs.yml
 create mode 100644 docs/assets/logo.svg
 create mode 100644 docs/index.md
 create mode 100644 mkdocs.yml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..9d6c57f
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,30 @@
+name: publish docs
+on:
+  push:
+    branches:
+      - master
+      - main
+      - v2
+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
\ No newline at end of file
diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg
new file mode 100644
index 0000000..1fa5052
--- /dev/null
+++ b/docs/assets/logo.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 365.58 336.34"><defs><linearGradient id="a" x1="-2.2" y1="56.69" x2="369.74" y2="56.69" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#2332c8"/><stop offset="1" stop-color="#6441a5"/></linearGradient><linearGradient id="b" x1="-2.2" y1="47.98" x2="369.74" y2="47.98" xlink:href="#a"/><linearGradient id="c" x1="-2.2" y1="178.11" x2="369.74" y2="178.11" xlink:href="#a"/><linearGradient id="d" x1="-2.2" y1="194.78" x2="369.74" y2="194.78" xlink:href="#a"/><linearGradient id="e" x1="-2.2" y1="253.28" x2="369.74" y2="253.28" xlink:href="#a"/></defs><title>Element 12</title><polygon points="190.1 49.13 190.1 69.24 207.98 44.13 190.1 49.13" style="fill:url(#a)"/><polygon points="365.58 0 263.22 28.66 205.64 95.97 365.58 51.18 365.58 0" style="fill:url(#b)"/><polygon points="190.1 283.11 248.6 266.73 248.6 149.74 365.58 116.99 365.58 73.12 190.1 122.25 190.1 283.11" style="fill:url(#c)"/><polygon points="58.49 144.48 155.98 117.18 175.48 89.79 175.48 53.23 0 102.36 0 336.34 58.49 254.15 58.49 144.48" style="fill:url(#d)"/><polygon points="116.99 199.59 116.99 245.09 65.81 259.42 0 336.34 175.48 287.2 175.48 170.22 131.61 182.5 116.99 199.59" style="fill:url(#e)"/></svg>
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..000ea34
--- /dev/null
+++ b/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.
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..0da9d5a
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,44 @@
+site_name: Gameyfin Docs (beta)
+site_url: https://gameyfin.github.io
+theme:
+  name: material
+  logo: assets/logo.svg
+  favicon: assets/logo.svg
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: white
+      accent: purple
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: blue
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  font:
+    code: JetBrains Mono
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - admonition
+  - pymdownx.details
\ No newline at end of file