init docs

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: docs
+on:
+  push:
+    branches:
+      - *
+
+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
+          git config user.email [email protected]
+      - 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 -r requirements-docs.txt
+      - run: mike deploy test-${GITHUB_REF##*/} --push

.gitignore

@@ -13,3 +13,8 @@ logs/
 *.iml
 classes/
 out/
+
+# docs build and cache
+.cache
+site/
+

docs/faq.md

@@ -0,0 +1,5 @@
+# FAQ
+
+## issues
+
+## common problems

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,18 @@
+site_name: HDSkins
+site_url: https://minelittlepony-mod.com/hdskins/
+
+repo_url: https://github.com/MineLittlePony/HDSkins
+
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+
+plugins:
+  - search
+  - social
+  - mike:
+
+extra:
+  versioning:
+    provider: mike

requirements-docs.txt

@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-material[imaging]
+mike