Vuepress Themes & Templates Logo Vuepress Themes & Templates
Doxybook2 screenshot

Doxybook2

Author Avatar Theme by Matusnovak
Updated: 19 Oct 2022
183 Stars

Doxygen XML to Markdown (or JSON)

Github Live Preview

Categories

Hugo Mkdocs Documentation

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

Installation

To install Doxybook2, follow these steps:

  1. Clone the repository:
git clone [repository-url]
  1. Install the requirements:
npm install
  1. Build the project:
npm run build

Summary

Doxybook2 is a tool for converting Doxygen XML files into markdown or JSON. It provides support for various static site generators and allows users to customize the output using templates. The C++ version of the tool offers improved memory usage and customization compared to its previous Python version. Users can install Doxybook2 by cloning the repository, installing the requirements, and building the project.