Merge pull request #5 from ubaumann/main

Add first version of material theme with custom yellow

.github/workflows/docs.yaml

@@ -0,0 +1,42 @@
+name: mkdocs
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yaml"
+  release:
+    types: [published]
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Cache Poetry virtualenv
+        uses: actions/cache@v4
+        id: cached-poetry-dependencies
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install Dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+
+      - name: Publish mkdocs to gh
+        run: poetry run mkdocs gh-deploy --force

README.md

@@ -80,4 +80,4 @@ This is a development server and will reload automatically so you can see your c
 
 ### Screenshots
 
-![Example of the rendered page](./docs/img/autonomicon_rtd.png)
+![Example of the rendered page](./docs/img/autonomicon_material.png)

docs/stylesheets/extra.css

@@ -0,0 +1,8 @@
+:root {
+    --md-primary-fg-color:        #ffff00;
+    --md-primary-fg-color--dark:  #ffff00bb;
+    --md-primary-bg-color:        #1d0935;
+
+    --md-accent-fg-color:         hsl(0deg, 0%, 86.27%);
+
+  }

mkdocs.yml

@@ -1,8 +1,26 @@
 ---
 site_name: "Autonomicon Docs"
+site_description: We're building out a lexicon / glossary for "standard" and/or common network automation terms and concepts...
 nav:
   - Home: "index.md"
   - Glossary: "glossary.md"
   - Collaborative Engineering Interpretations: "interpretations.md"
   - Links: "links.md"
-theme: "readthedocs"
+
+repo_url: https://github.com/Network-Automation-Forum/autonomicon
+repo_name: Network-Automation-Forum/autonomicon
+
+theme:
+  name: material
+  logo: img/NAF.png
+  favicon: img/favicon.png
+  palette:
+    - scheme: slate
+      primary: custom
+      accent: custom
+  features:
+    - navigation.tracking
+extra:
+  homepage: https://networkautomation.forum/
+extra_css:
+  - stylesheets/extra.css

pyproject.toml

@@ -13,6 +13,7 @@ python = "^3.8"
 yamllint = "*"
 Markdown = "*"
 mkdocs = "^1.5.3"
+mkdocs-material = "^9.5.13"
 
 [build-system]
 requires = ["poetry-core"]