[WIP] Publish mkdocs site to GitHub Pages (#18) #1

	name: Deploy MkDocs to GitHub Pages

	on:
	push:
	branches:
	- main
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- '.github/workflows/docs.yml'
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: pages
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	with:
	fetch-depth: 0 # Required for git-revision-date-localized plugin

	- name: Setup Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"

	- name: Install MkDocs and plugins
	run: \|
	python -m pip install --upgrade pip
	pip install mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-awesome-pages-plugin mkdocs-git-revision-date-localized-plugin

	- name: Build MkDocs site
	run: mkdocs build --clean

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: site

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback