Getting Started

Quickstart

Get started with Moxygen in under a minute

Install

npm install moxygen -g

Requires Node.js 20+.

Generate docs

  1. Add GENERATE_XML=YES to your Doxyfile
  2. Run doxygen to generate the XML
  3. Run moxygen pointing to the XML output directory
moxygen --anchors /path/to/doxygen/xml

For multi-file grouped output:

moxygen --anchors --groups --output api-%s.md /path/to/doxygen/xml

Next, see Writing Doxygen for the comment patterns and Doxyfile settings that produce the cleanest output.