Documentation stub

Author: lukekoch

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+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

.gitignore

@@ -0,0 +1 @@
+.venv

docs/assets/gnom.png

@@ -0,0 +1,3 @@
+# Welcome to the G-nom docs
+
+The is the documentation for the G-nom projects and core plugins. We are currently in the process of setting up the documentation.

docs/index.md

@@ -0,0 +1,29 @@
+site_name: G-nom Docs
+site_url: https://g-nom-project.github.io
+repo_url: https://github.com/G-nom-Project/g-nom
+repo_name: G-nom-Project/g-nom
+theme:
+  logo: assets/gnom.png
+  favicon: assets/gnom.png
+  icon:
+    repo: fontawesome/brands/github 
+  name: material
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/link
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: indigo
+      toggle:
+        icon: material/toggle-switch-off
+        name: Switch to system preference