This starter repo includes:
- Node 24-ready GitHub Actions workflows
- updated Pages actions (
upload-pages-artifact@v4,deploy-pages@v5) - dynamic
MKDOCS_SITE_URLinjection - bootstrap mode so the public repo can deploy without private repos
- optional vs required private repository handling
- anonymous HTTPS fallback for public repositories
- tag-driven promotion policy
- helper to generate
docs-metadata.ymlfrom a source repomkdocs.yml - JSON Schema validation for
docs-metadata.yml - full
mkdocs.base.ymlwith Material, minify, graph, macros, MathJax, consent, and CSS/JS hooks
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
./scripts/bootstrap-docs.sh --from-examples
mkdocs serve -f mkdocs.generated.ymlThis release includes full documentation for the principal configuration files:
repositories.ymlpromotion.ymlmkdocs.base.ymldocs-metadata.yml.env.examplerequirements.txt
These are documented in docs/shared/ and included in the generated navigation.