feat: render as html for gh pages

Author: faretek1

.github/workflows/gh-pages.yml

@@ -0,0 +1,34 @@
+name: Send to gh pages branch
+on:
+  push:
+    branches:
+      - automated_mkdocs
+      -
+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[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - 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 mkdocs-material
+      - run: mkdocs gh-deploy --force

.github/workflows/mkdoc.yml

@@ -44,5 +44,6 @@ jobs:
       run: |
         git reset HEAD -- .
         git add docs/*.md
+        git add mkdocs.yml
         git commit -m "automated docs"
         git push --set-upstream origin automated_mkdocs --force

mkdocs.yml

@@ -0,0 +1,60 @@
+site_name: GDSL Automated docs
+
+# site_url: https://mydomain.org/mysite
+# mostly copied from https://github.com/aspizu/goboscript/blob/main/mkdocs.yml
+theme:
+  name: material
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.instant.preview
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.expand
+    - content.code.annotate
+    - toc.follow
+    - navigation.path
+    - navigation.top
+    - content.code.copy
+    - content.tabs.link
+  font:
+      text: Inter Tight
+      code: Cascadia Code
+  palette:
+    # Note: Using the system theme works with the insiders version
+    # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+markdown_extensions:
+    - admonition
+    - pymdownx.details
+    - toc:
+          permalink: "#"
+    - pymdownx.snippets
+    - pymdownx.magiclink
+    - attr_list
+    - md_in_html
+    - pymdownx.highlight:
+          anchor_linenums: true
+    - pymdownx.inlinehilite
+    - pymdownx.superfences
+    - markdown.extensions.attr_list
+    - pymdownx.keys
+    - pymdownx.tasklist:
+          custom_checkbox: true
+    - pymdownx.tabbed:
+          alternate_style: true