Publish new docs site (#87)

.github/workflows/mkdocs-ci.yml

@@ -0,0 +1,39 @@
+name: ci 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - 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
+      - uses: actions/setup-node@v4
+      - run: |
+          npm i
+          npm i -g ts-node
+          cd builder
+          mkdir dist
+          ts-node build.ts
+          cp dist/plugins/* ../docs/plugins/list.md
+          cp dist/themes/* ../docs/themes/list.md
+      - run: pip install \ 
+               mkdocs-material=="9.*" \
+               mkdocs-rss-plugin \
+               mkdocs-git-revision-date-localized-plugin \
+               mkdocs-git-committers-plugin-2 \
+               mkdocs-glightbox \
+               mkdocs-material[imaging] \
+               mkdocs-redirects
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -1,4 +1,6 @@
 # ignore directories for local testing
-.jekyll-cache/
-_site/
-.vscode
+.vscode
+site
+.cache
+node_modules/
+builder/dist/*

CONTRIBUTING.md

@@ -1,8 +1,10 @@
 # Contributing
 
-## Contributing from the site via `Edit this page on GitHub`
+Pull requests are welcome. If you are unfamilair with MkDocs/Material for MkDocs sctructure, look through [their documentation](https://squidfunk.github.io/mkdocs-material) for general idea for how it's structured and handy references.
 
-1. On the bottom of every page you will find a link `Edit this page on GitHub`.
+## Contributing from the site via edit button
+
+1. At the top of every page you will find an edit button
 2. Cliking on it will open GitHub where you will be met with a message about not being able to edit directly.
 3. Click `Fork this repository`.
 4. You should see the text editor now.
@@ -33,4 +35,4 @@
 7. Click `Propose changes`.
 8. Next page might look complicated, but all you need to do next is click `Create pull request`.
 9. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
-10. That's it!
+10. That's it!