What problem does it solve?
Stig automates the generation of documentation from C/C++ sources by converting Doxygen-style comments into markdown, mdbook, JSON, or HTML formats, improving consistency and readability for API references.
Core Features & Use Cases
- Parses Doxygen-style comments using fast parsing to produce multiple outputs formats (markdown, mdbook, JSON, HTML).
- Generates cross-referenced documentation with links between types, functions, and pages, enabling easy navigation and CI/CD integration.
- Supports configurable workflows via stig.toml for output customization, section naming, and external docs linking; ideal for maintainers who need up-to-date docs in repo dashboards or published docs.
Quick Start
Install stig and run a simple generate against your sources, for example: stig generate -o docs -f mdbook include/*.hpp