feat: add github pages workflow

.github/workflows/gh-pages.yml

@@ -0,0 +1,27 @@
+name: GitHub Pages
+
+on:
+  push:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+          cache: 'pip' # caching pip dependencies
+      - name: Install Dependencies
+        run: pip install -r requirements.txt
+      - name: Deploy
+        if: ${{ github.ref == 'refs/heads/main' }}
+        run: mkdocs gh-deploy --strict --force

.gitignore

@@ -1 +1,2 @@
 bin/
+site/

README.md

@@ -79,6 +79,7 @@ The documentation is built with [mkdocs](https://www.mkdocs.org/) and [mkdocs-ma
 It can be served as follows:
 
 ```plaintext
+pip3 install -r requirements.txt
 mkdocs serve
 ```
 

requirements.txt

@@ -0,0 +1,29 @@
+Babel==2.14.0
+certifi==2023.11.17
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+ghp-import==2.1.0
+idna==3.6
+Jinja2==3.1.2
+Markdown==3.5.1
+MarkupSafe==2.1.3
+mergedeep==1.3.4
+mkdocs==1.5.3
+mkdocs-material==9.5.3
+mkdocs-material-extensions==1.3.1
+packaging==23.2
+paginate==0.5.6
+pathspec==0.12.1
+plantuml-markdown==3.9.2
+platformdirs==4.1.0
+Pygments==2.17.2
+pymdown-extensions==10.7
+python-dateutil==2.8.2
+PyYAML==6.0.1
+pyyaml_env_tag==0.1
+regex==2023.12.25
+requests==2.31.0
+six==1.16.0
+urllib3==2.1.0
+watchdog==3.0.0