Generate markdown API documentations for C++ libraries
  • C++ 83%
  • Lex 9.6%
  • JavaScript 1.8%
  • Python 1.4%
  • Go Template 1.2%
  • Other 2.7%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-10-25 10:06:26 +08:00
.github set default pr reviewer to owner 2026-10-25 10:06:26 +08:00
ext/doxygen fix cmake/python deprecations and bump ci actions/checkout to v5 2026-05-17 20:13:09 +08:00
src fix cmake/python deprecations and bump ci actions/checkout to v5 2026-05-17 20:13:09 +08:00
tests add install, build, test scripts 2020-10-08 20:33:07 +08:00
utils fix cmake/python deprecations and bump ci actions/checkout to v5 2026-05-17 20:13:09 +08:00
.gitignore update issue templates, ci branches and gitignore 2022-12-03 14:03:31 +08:00
CMakeLists.txt fix cmake/python deprecations and bump ci actions/checkout to v5 2026-05-17 20:13:09 +08:00
LICENSE update license 2020-10-08 20:31:20 +08:00
make.sh fix cmake/python deprecations and bump ci actions/checkout to v5 2026-05-17 20:13:09 +08:00
README.md update doc and ci make.sh script 2020-12-12 20:30:23 +08:00

Doxygenmd

Linux Mac
Linux macOS

Doxygenmd is a simple tool for generating markdown API documentation from source code.

Supported languages: C++

Example Usage

$ doxygenmd src doc

Supported Platforms

Doxygenmd is developed and tested on Linux and macOS. Current version has been tested on:

  • macOS Big Sur 11.0
  • Ubuntu 20.04 LTS

Build / Install

Linux / Ubuntu

Dependencies

sudo apt install bison flex git

Source

git clone https://github.com/d99kris/doxygenmd && cd doxygenmd

Build

mkdir -p build && cd build && cmake .. && make -s

Install

sudo make install

macOS

Dependencies

brew install bison flex

Source

git clone https://github.com/d99kris/doxygenmd && cd doxygenmd

Build

mkdir -p build && cd build && cmake .. && make -s

Install

make install

Technical Details

Doxygenmd is implemented in Python. It uses Doxygen to parse source code and generate man-pages, which it subsequently processes and converts into Markdown.

The source tree includes the source code of the following third-party softwares:

  • Doxygen - GPLv2 License - Copyright (C) by Dimitri van Heesch

License

Doxygenmd is distributed under the GPLv2 license. See LICENSE file.

Keywords

api documentation, doxygen, generate, markdown.