https://github.com/profiler4100/doxygen2markdown

NodeJS CLI application that converts Doxygen XML documentation into Markdown files for Bitbucket Wiki, GitHub Pages and other places.
https://github.com/profiler4100/doxygen2markdown

Last synced: about 1 month ago
JSON representation

NodeJS CLI application that converts Doxygen XML documentation into Markdown files for Bitbucket Wiki, GitHub Pages and other places.

• Host: GitHub
• URL: https://github.com/profiler4100/doxygen2markdown
• Owner: ProFiLeR4100
• License: gpl-3.0
• Created: 2020-01-25T10:33:38.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-07T20:34:15.000Z (over 1 year ago)
• Last Synced: 2024-10-09T17:04:06.802Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 96.7 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Doxygen => Markdown

[![NPM version](https://img.shields.io/npm/v/doxygen2markdown)](https://npmjs.org/package/doxygen2markdown)

[![Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fprofiler4100&style=flat)](https://www.patreon.com/profiler4100)

NodeJS CLI application that converts Doxygen XML documentation into Markdown files for Bitbucket Wiki, GitHub Pages and other places.

## Installation

Install this app by running next code using terminal (Unix/Linux/MacOS) or command prompt (Windows) 

```

npm i -g doxygen2markdown 

```

## Usage

1. Add `GENERATE_XML=YES` to your `Doxyfile` first.

2. Run `doxygen` to generate the XML documentation.

3. Install `doxygen2markdown` like so: `npm install doxygen2markdown -g` if you don't do this earlier.

4. Run `doxygen2markdown` providing the folder location of the XML documentation as it is said in documentation.  

**P.S.** You can see options by running next command `doxygen2markdown` without any options.

**P.S.S.** For template syntax read the [documentation for EJS](https://github.com/mde/ejs) 

```

doxygen2markdown

Options:

  -V, --version           Output the version number

  -d, --doxygen     Doxygen XML output directory

  -o, --output      Converter output directory.

  -t, --templates   Custom templates directory. (optional)

  -v, --verbose           Outputs every filename that was converted. (optional) (default: false)

  -q, --quiet             Completely disables output. (optional) (default: false)

  -h, --help              Output usage information

```

## Examples

To convert documentation you can use next command:

`doxygen2markdown -d "" -o ""`

If you want to convert documentation with your own templates, use next command:  

`doxygen2markdown -d "" -o "" -t ""`

**P.S.** You can copy templates folder from this repository to get a fast start.

**P.S.S.** For template syntax read the [documentation for EJS](https://github.com/mde/ejs) 

## ToDo list

1. Add group, namespace conversion support.

2. Add code conversion to to class/interface.

3. Add Doxygen AUTOLINK_SUPPORT flag support.

## Patrons 

Auto update WIP

## Become a Patron

Support this project by becoming a Patron on Patreon. [Sponsor this developer ❤](https://www.patreon.com/profiler4100)

## License

Read LICENSE file for detailed information.