mkdocs, make it simple, make it work

.github/workflows/docs.yml

@@ -0,0 +1,22 @@
+# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions
+name: Build docs page
+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@v4
+        with:
+          python-version: 3.x
+      - run: pip install -r docs/requirements.txt
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -13,3 +13,6 @@ __pycache__
 *.mcdr
 *.pyz
 /run
+
+# docs
+/site/

docs/example.md

@@ -0,0 +1 @@
+default english example

docs/example.zh.md

@@ -0,0 +1 @@
+中文example

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.

docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-material
+mkdocs-static-i18n[material]

mkdocs.yml

@@ -0,0 +1,40 @@
+# https://www.mkdocs.org/
+site_name: Prime Backup Documents
+site_url: https://tisunion.github.io/PrimeBackup/
+site_author: Fallen_Breath
+site_description: A powerful backup plugin for MCDR, an advanced backup solution for your Minecraft world
+repo_url: https://github.com/TISUnion/PrimeBackup
+copyright: Copyright © 2023 Fallen_Breath
+exclude_docs: |-
+  /requirements.txt
+theme:
+  name: material
+  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+plugins:
+  - search
+  - i18n:
+      # https://ultrabug.github.io/mkdocs-static-i18n/getting-started/quick-start/#configure-the-plugin-in-your-mkdocsyml
+      docs_structure: suffix
+      languages:
+        - locale: en
+          default: true
+          name: English
+          build: true
+        - locale: zh
+          name: 简体中文
+          build: true