Update GitHub Actions workflow for MkDocs deployment

Author: Snorfield

.github/workflows/deploy.yml

@@ -1,23 +1,33 @@
 name: Deploy MkDocs to GitHub Pages
+
 on:
- push:
-   branches:
-     - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
 jobs:
- deploy:
-   runs-on: ubuntu-latest
-   steps:
-     - name: Checkout Code
-       uses: actions/checkout@v2
-     - name: Setup Python
-       uses: actions/setup-python@v2
-       with:
-         python-version: '3.x'
-     - name: Install Dependencies
-       run: |
-         pip install mkdocs
-     - name: Build and Deploy
-       run: |
-         mkdocs gh-deploy --force
-       env:
-         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install MkDocs
+        run: pip install mkdocs
+
+      - name: Build site
+        run: mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site