A modern documentation generator for C++ that uses YAML configuration, outputs Markdown, and integrates with static site generators.
Doxide is a modern documentation generator for C++ projects that uses YAML for configuration and outputs Markdown files. It solves the problem of creating contemporary, responsive documentation for C++ codebases by integrating with popular static site generators and themes.
C++ developers and teams who need to generate and maintain documentation for their projects, particularly those who want modern-looking documentation that works well on all devices.
Developers choose Doxide because it offers a simpler YAML-based configuration compared to traditional tools, produces Markdown output compatible with modern static site generators, and is written in C++ for easier contribution by its primary user base.
Modern documentation for modern C++. Configure with YAML, output Markdown, post-process with Material for MkDocs.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Uses simple YAML files instead of complex command-line options, making configuration easy to version control and modify, as highlighted in the README's quick start.
Generates Markdown compatible with static site generators like MkDocs, enabling responsive HTML with contemporary styling for desktop and mobile, per the README's emphasis on modern design.
Leverages Tree-sitter for C++ code analysis, ensuring precise parsing similar to syntax highlighters, which supports accurate documentation generation from source code.
Supports many Doxygen commands in code comments, allowing developers to use familiar documentation patterns without fully switching tools, as noted in the README.
Runs on Linux, Mac, and Windows with available packages, making it accessible for diverse development environments, as specified in the installation instructions.
Requires building from source with dependencies like CMake and LibYAML, which can be cumbersome and error-prone compared to tools with simpler package manager installs.
Only supports many, not all, Doxygen commands, limiting its use for projects relying on advanced or niche documentation features admitted in the README.
To produce HTML, users must install and configure separate static site generators like MkDocs, adding extra steps and potential compatibility issues to the workflow.
As a newer project, it lacks extensive plugins, integrations, and community support compared to established documentation generators, which could affect long-term maintenance.
Doxide is an open-source alternative to the following products: