Docs

fix(sanitizer): scan markdown bodies and prose-style values for literal secrets #37

	name: Docs

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

	permissions:
	contents: write

	concurrency:
	group: docs-${{ github.ref }}
	# PR builds can be cancelled when a newer commit lands; deploy runs
	# on main must not be cancelled mid-flight to avoid a half-published site.
	cancel-in-progress: ${{ github.event_name == 'pull_request' }}

	jobs:
	build:
	runs-on: ubuntu-24.04
	steps:
	- uses: actions/checkout@v6
	with:
	fetch-depth: 0

	- uses: actions/setup-python@v6
	with:
	python-version: "3.x"
	cache: pip
	cache-dependency-path: docs/requirements.txt

	- name: Install dependencies
	run: pip install -r docs/requirements.txt

	- name: Build (strict)
	run: mkdocs build --strict

	- name: Deploy to GitHub Pages
	if: github.event_name == 'push' \|\| github.event_name == 'workflow_dispatch'
	run: mkdocs gh-deploy --force

Navigation Menu