docs: new publish workflow

.github/workflows/publish-docs.yml

@@ -1,4 +1,5 @@
 name: Publish docs via GitHub Pages
+
 on:
   push:
     branches:
@@ -11,10 +12,24 @@ jobs:
     name: Deploy docs
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout main
+      - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ssh-key: ${{ secrets.DEPLOY_KEY }}
 
-      - name: Deploy docs
+      - name: Set up Python
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        uses: actions/setup-python@v5
-        env:
+        with:
-          PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: pip install mkdocs-material
+
+      - name: Configure Git identity
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

mkdocs.yml

@@ -1,3 +1,10 @@
 site_name: Brittle Star Project
 theme:
   name: material
+
+markdown_extensions:
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format