Static Docs
Build polished documentation sites from Markdown with a pure-Python CLI.
Static Docs builds documentation sites from Markdown using a Python-only workflow. You write pages in content/, configure navigation with navigation.yml, and build static HTML into dist/.
Getting started
Install Static Docs, scaffold a site, preview locally, and build static HTML.
Components
Use callouts, cards, tabs, file trees, steps, badges, parameters, details, captions, and Mermaid.
API docs
Generate API reference pages from Python files and docstrings.
Deploy
Publish to GitHub Pages with a GitHub Actions workflow.
What you get
- 1
Markdown authoring
Write normal Markdown plus Static Docs directives for docs components.
- 2
Built-in docs theme
Get a sidebar, top navigation, right-side table of contents, search, dark mode, and polished code blocks.
- 3
Production outputs
Generate HTML, search index, SEO files, and LLM-friendly docs files.
Build this documentation
static-docs build --config docs/site.toml
The output is written to: