Doxybook2
Doxygen XML to Markdown (or JSON)
Overview
Doxybook2 is a command line tool that converts Doxygen generated XML files into markdown files or JSON. It allows users to create beautiful C++ documentation using static site generators such as MkDocs, GitBook, VuePress, Hugo, Docsify, or any other generator that supports markdown. This C++ version of the tool aims to improve memory usage, templating, and customization compared to its predecessor (doxybook). The project is not limited to the mentioned static site generators, and users can create their own templates or generate JSON output for further customization.
Features
- Conversion of Doxygen XML files into markdown or JSON
- Support for various static site generators including MkDocs, GitBook, VuePress, Hugo, Docsify
- Improved memory usage and customization compared to the previous Python version (doxybook)
- Ability to generate JSON-only output for further customization
- Support for custom templates to modify Markdown output
- Command line arguments for configuration and usage
- Hugo
Hugo is an open-source static site generator that features fast build times, flexible themes, support for multiple content formats, multilingual websites, live reloading, and an active community. It allows developers to easily create and deploy SEO-friendly and mobile-responsive websites.
- 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.
- Vuepress
VuePress is a minimalistic static site generator based on Vue.js that allows developers to create fast, SEO-friendly, and customizable documentation websites.
- 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.
