Basic mkdocs website with github action deploy

.github/workflows/deploy.yaml

@@ -0,0 +1,56 @@
+---
+name: Deploy MKDocs to GitHub Pages
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - klaas-2024-*
+
+env:
+  DEFAULT_PYTHON: "3.11"
+
+jobs:
+  build-docs:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/[email protected]
+      - name: 🏗 Set up Poetry
+        run: pipx install poetry
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+          cache: "poetry"
+      - name: 🏗 Install workflow dependencies
+        run: |
+          poetry config virtualenvs.create true
+          poetry config virtualenvs.in-project true
+      - name: 🏗 Install dependencies
+        run: poetry install --no-interaction
+      - name: 🏗 Build the site
+        run: poetry run mkdocs build
+      - name: ⬆️ Upload pages artifacts
+        uses: actions/[email protected]
+        with:
+          path: site
+
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    needs: build-docs
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: 🏗️ Setup Github Pages
+        uses: actions/[email protected]
+      - name: 🚀 Deploy to Github Pages
+        uses: actions/[email protected]
+        id: deployment

.gitignore

@@ -1,2 +1,6 @@
 # Folders to ignore
-__pycache__
+__pycache__
+.cache
+
+# Files to ignore
+.python-version

docs/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

docs/index.md

@@ -0,0 +1,3 @@
+# Hello World
+
+Give me a sec to get this up and running 😄

mkdocs.yml

@@ -0,0 +1,54 @@
+# Project
+site_name: Stream Overlays
+site_url: https://overlays.dutchdronesquad.nl
+site_author: Klaas Schoute
+site_description: >-
+  A RotorHazard plugin with collection of stream overlays to use with OBS Studio or similar software.
+
+# Repository
+repo_name: rh-stream-overlays
+repo_url: https://github.com/dutchdronesquad/rh-stream-overlays
+edit_uri: edit/main/docs/
+
+# Configuration
+theme:
+  name: material
+  icon:
+    logo: fontawesome/solid/display
+  palette:
+    primary: blue
+    accent: orange
+  features:
+    - content.action.edit
+    - content.action.view
+    - navigation.indexes
+    - navigation.tabs
+    - navigation.top
+nav:
+  - Home: index.md
+plugins:
+  - blog
+  - search:
+      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+
+nav:
+  - Home: index.md
+  - Blog:
+      - blog/index.md
+
+# Extra
+extra:
+  status:
+    new: Recently added
+    deprecated: Deprecated
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/dutchdronesquad
+    - icon: fontawesome/brands/instagram
+      link: https://instagram.com/dutchdronesquad
+    - icon: fontawesome/brands/youtube
+      link: https://youtube.com/@dutchdronesquad
+    - icon: fontawesome/brands/facebook
+      link: https://facebook.com/dutchdronesquad
+  version:
+    provider: mike

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "rh-stream-overlays"
+package-mode=false
+description = "A RotorHazard plugin with collection of stream overlays to use with OBS Studio or similar software."
+authors = ["Klaas Schoute <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+mkdocs = "^1.6.0"
+mkdocs-material = "^9.5.29"
+mike = "^2.1.2"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"