Docs / Documentation deployment
DEPLOYED
⏱️ 1 min read · 198 words
Documentation deployment
Canonical host
https://docs.denialos.io
How a page is published
- content is authored as Markdown with front matter in
docs/public/; - the page is rendered into
docs-site/, which is the published static artifact; - the source and the published page are committed together, so the served page is always the reviewed artifact.
Artifacts
- HTML pages with per-page canonical, robots, Open Graph/Twitter, and JSON-LD metadata;
- a client-side search index;
robots.txt,sitemap.xml, a clean-route redirect map, and security headers;llms.txtandopensearch.xmlfor crawlers and browsers;- host verification files for search consoles.
Note on the renderer
scripts/build-public-docs.py renders the Markdown source into a dependency-light page shell. It does not reproduce the published page design (navigation, footer, previous/next links), so it must not be run over the published directory. Non-Markdown artifacts that no renderer emits live in the published directory and are committed as-is.
Deployment requirements
Serve the published directory from a static host/CDN that honors the included clean-route and security configuration.
Set PUBLIC_DOCS_BASE_URL when rendering for a host other than the default.
Do not expose docs/internal/ or repository secrets through the public static host.