Doxide
Modern documentation for modern C++. Configure with YAML, output Markdown, post-process with Material for MkDocs.
Overview
Doxide is a cutting-edge documentation generator specifically designed for C++ developers, streamlining the process of creating, maintaining, and publishing documentation. It leverages the YAML configuration format to generate Markdown and then converts it into sleek, responsive HTML that functions beautifully on both desktop and mobile devices. Being an open-source solution under the Apache 2.0 license, Doxide empowers developers across various operating systems, including Linux, Mac, and Windows, by allowing them to contribute directly to its development.
What sets Doxide apart is its ability to make C++ documentation accessible to a broader audience by integrating seamlessly with popular static site generation tools and themes, thus elevating the documentation process into a modern era. Its support for existing Doxygen commands and parsing capabilities through Tree-sitter enhances user experience while maintaining familiarity for seasoned developers.
Features
- Open Source: Doxide operates under the Apache 2.0 license, allowing users to freely use and modify the software.
- Cross-Platform Support: Runs effortlessly on Linux, Mac, and Windows systems, catering to a diverse user base.
- YAML Configuration: Simplifies setup and customization through an easy-to-understand YAML file.
- Markdown Generation: Outputs documentation in Markdown format, making it compatible with numerous static site generators.
- Responsive Design: Generates HTML documentation that looks great on both desktop and mobile devices.
- Doxygen Compatible: Supports many existing Doxygen commands, easing the transition for current users of Doxygen.
- Extensible Documentation: Offers particular support for MkDocs and other static site generators, such as Jekyll and Hugo, for flexible publishing options.
- Automatic Dependency Management: Simplifies installation by handling required dependencies through submodules during the build process.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
