docs: add mkdocs plumbing

.github/workflows/mkdocs.yaml

@@ -0,0 +1,21 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - main
+      - mkdocs
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v2
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: ./mkdocs.yml

mkdocs.yml

@@ -1,5 +1,32 @@
-site_name: Pygmy Documentation
-theme: readthedocs
+site_name: 'Pygmy'
+site_url: https://pygmystack.github.io/pygmy/
+repo_url: https://github.com/pygmystack/pygmy/
+repo_name: pygmystack/pygmy
+edit_uri: edit/main/docs
+site_author: The pygmystack authors
+
+theme:
+  name: 'material'
+  palette:
+    primary: 'blue'
+    accent: 'light blue'
+  favicon: images/pygmystack_icon.png
+  logo: images/pygmystack_icon_wh.png
+  icon:
+    repo: fontawesome/brands/github 
+
+markdown_extensions:
+  - toc:
+      permalink: "#"
+      baselevel: 2
+  - admonition
+  - attr_list
+  - tables
+  - pymdownx.highlight
+  - pymdownx.superfences
+
+plugins:
+  - search
 
 nav:
   - Pygmy: index.md
@@ -14,9 +41,3 @@ nav:
   - Mapping additional ports: map_addtitional_ports.md
   - Customisation:
       - Introduction: customisation/introduction.md
-
-markdown_extensions:
-  - toc:
-      permalink: true
-      baselevel: 1
-  - admonition