docs: migrate docs to MkDocs Material

Bionus · Aug 17, 2023 · 47deb97 · 47deb97
1 parent 0f774c4
commit 47deb97
Show file tree

Hide file tree

Showing 172 changed files with 1,132 additions and 11,090 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,47 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - mkdocs.yml
+      - docs/**
+      - .github/workflows/docs.yml
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install Python dependencies
+        run: pip install mkdocs-material==9.2.0b3 mkdocs-awesome-pages-plugin mkdocs-macros-plugin mkdocs-git-revision-date-localized-plugin mkdocs-glightbox
+
+      - name: Patch blog dates to support datetimes
+        run: sed -i 's|date.fromisoformat|datetime.fromisoformat|' $(pip show mkdocs-material | grep Location | cut -d ' ' -f 2)/material/plugins/blog/plugin.py
+
+      - name: Deploy to Github Pages
+        run: mkdocs gh-deploy --force
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/_category/android.md b/docs/_category/android.md
diff --git a/docs/_category/linux.md b/docs/_category/linux.md
diff --git a/docs/_category/release.md b/docs/_category/release.md
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_data/docs_navigation.yml b/docs/_data/docs_navigation.yml
diff --git a/docs/_docs/sources.md b/docs/_docs/sources.md
diff --git a/docs/_includes/blog.html b/docs/_includes/blog.html
diff --git a/docs/_includes/body.html b/docs/_includes/body.html
diff --git a/docs/_includes/navbar_link.html b/docs/_includes/navbar_link.html
diff --git a/docs/_includes/post_preview.html b/docs/_includes/post_preview.html
diff --git a/docs/_includes/source_list.html b/docs/_includes/source_list.html
diff --git a/docs/_layouts/blog.html b/docs/_layouts/blog.html
diff --git a/docs/_layouts/blog_category.html b/docs/_layouts/blog_category.html