feat: add GitHub Actions workflow for deploying MkDocs to GitHub Pages #1

	name: Deploy MkDocs to GitHub Pages

	on:
	push:
	branches:
	- main
	pull_request:
	branches:
	- main
	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 # Fetch full history for git-revision-date-localized plugin

	- name: Setup Python
	uses: actions/setup-python@v4
	with:
	python-version: '3.x'

	- name: Cache pip dependencies
	uses: actions/cache@v3
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pip-${{ hashFiles('/requirements.txt', '/pyproject.toml') }}
	restore-keys: \|
	${{ runner.os }}-pip-

	- name: Install dependencies
	run: \|
	pip install --upgrade pip
	pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin

	- name: Setup Pages
	uses: actions/configure-pages@v3

	- name: Build with MkDocs
	run: mkdocs build --strict

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

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v2

Provide feedback