Merge pull request #3 from justenstall/mkdocs

Use mkdocs

.gitattributes

@@ -0,0 +1,5 @@
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.xcf filter=lfs diff=lfs merge=lfs -text

.github/workflows/ci.yml

@@ -1,20 +1,32 @@
-name: CI
+name: ci
+
 on:
   push:
     branches:
-      - '**'
-  pull_request:
-    branches:
-      - '**'
+      - master
+      - main
+
+permissions:
+  contents: write
 
 jobs:
-  release:
+  deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: go-semantic-release/action@v1
-        id: semrel
+      - 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@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          update-file: VERSION
-          changelog-generator-opt: "emojis=true"
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+# repos:
+#   - repo: local
+#     hooks:
+#       - id: mkdocs-build
+#         name: Generate static site with mkdocs build
+#         entry: bash -c 'task build'
+#         language: system
+#         types: [text]
+#         stages: [commit, push, manual]
+#         files: site/.*

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+	"yaml.schemas": {
+		"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+	},
+	"yaml.customTags": [
+		"!ENV scalar",
+		"!ENV sequence",
+		"!relative scalar",
+		"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+		"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+		"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+	]
+}