Skip to main content

doxygen2docusaurus

Synopsis​

doxygen2docusaurus [--id <name>] [--verbose|--debug] [-C <path>]
doxygen2docusaurus --version
doxygen2docusaurus --help

Description​

The command converts Doxygen XML files to Docusaurus Markdown pages. It can also display the version or the help message.

Without any options, it performs the conversion using the default configuration.

% doxygen2docusaurus

Running 'doxygen2docusaurus' (1.1.0)...

Parsing Doxygen generated .xml files...
98 xml files parsed

Creating view model objects...
Creating compounds hierarchies...
Creating member definitions map...
Performing compounds late initializations...
Performing members late initializations...
Validating permalinks...

Removing existing folder docs/api/...

Writing Docusaurus .md pages...
119 .md files written

Writing sidebar file sidebar-category-doxygen.json...
Writing menu file docusaurus-config-navbar-doxygen.json...
Copying image file static/img/doxygen2docusaurus/document-svgrepo-com.svg
Copying image file static/img/doxygen2docusaurus/folder-svgrepo-com.svg
Copying css file src/css/custom-doxygen2docusaurus.css

Running 'doxygen2docusaurus' has completed successfully in 683 ms.

Options​

Configuration id (--id)​

Specify a unique configuration identifier when the website comprises multiple reference sites.

Verbose (--verbose)​

Display additional details during the conversion process.

Debug (--debug)​

Display debug information during the conversion process.

Current folder (-C)​

Change the current working folder to the specified path before executing the conversion.

Version (-v, --version)​

Display the programme version.

% doxygen2docusaurus -v
1.1.0

Help (-h, --help)​

Display the help message.

$ doxygen2docusaurus --help
Usage: doxygen2docusaurus [options]

Options:
  --id <name>    configuration id, for multi-configurations
  --verbose      display more details during the conversion
  --debug        display debug lines during the conversion
  -C <path>      change the current folder
  -v, --version  display version
  -h, --help     display help for command