https://github.com/albin-johansson/doxy-to-md
Converts Doxygen XML output to Markdown files.
https://github.com/albin-johansson/doxy-to-md
cli cpp documentation doxygen markdown rust
Last synced: about 1 year ago
JSON representation
Converts Doxygen XML output to Markdown files.
- Host: GitHub
- URL: https://github.com/albin-johansson/doxy-to-md
- Owner: albin-johansson
- License: mit
- Created: 2022-03-02T16:54:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-09T16:16:27.000Z (over 4 years ago)
- Last Synced: 2025-04-05T03:23:05.945Z (over 1 year ago)
- Topics: cli, cpp, documentation, doxygen, markdown, rust
- Language: Rust
- Homepage:
- Size: 123 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# doxy-to-md
Converts Doxygen XML output to Markdown files.
## Disclaimer
[Centurion]: https://github.com/albin-johansson/centurion/
This tool was written for use by the [Centurion] project. It is not intended to perform perfect or 100% complete
conversions from Doxygen to Markdown. The goal is to provide a good overview of the APIs with minimal manual work to get
the API documentation available in Markdown format, which can be used in documentation generators such as GitBook,
mdBook, or Material for MkDocs.
## Building
This tool is written in Rust, which makes is very easy to build the tool locally. All you need is the Rust toolchain.
Simply clone and unzip the repository to somewhere on your machine and enter the following command in a shell, opened
in the root directory of the repository.
```shell
cargo build --release
```
When the compilation is done, you should be able to locate the binary, called `doxy-to-md`, in `target/release`.
## Usage
This tool processes the XML format emitted by Doxygen. However, Doxygen only emits HTML files by default, so you'll need
to set `GENERATE_XML` to `YES` in your Doxyfile. Then, run Doxygen on your sources to produce the XML files.
To run the `doxy-to-md` program, you need to supply two arguments, `-i`/`--input-dir` and `-o`/`--output-dir`. The input
directory is where `doxy-to-md` looks for the XML files produced by Doxygen. Subsequently, the output directory is where
the generated Markdown files will go.
The output directory will be created if it does not exist by the time `doxy-to-md` is executed.
```shell
./doxy-to-md -i path/to/doxygen/xml -o output/md
```