Nighttime Possum Meandering

    doxygen2markdown

    0.0.14 • Public • Published

    Doxygen => Markdown

    NPM version Patreon

    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

    doxygen2markdown
    Options:
      -V, --version           output the version number
      -d, --doxygen <type>    Doxygen XML output directory
      -o, --output <type>     Converter output directory.
      -t, --templates <type>  Custom templates directory
      -h, --help              output usage information
    

    Examples

    To convert documentation you can use next command:

    doxygen2markdown -d "<path to doxygen xml folder>" -o "<path to markdown folder>"

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

    doxygen2markdown -d "<path to doxygen xml folder>" -o "<path to markdown folder>" -t "<path to templates folder>"

    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

    ToDo list

    1. Add group, namespace conversion support
    2. Add code conversion to to class/interface

    Patrons

    Auto update WIP

    Become a Patron

    Support this project by becoming a Patron on Patreon. Sponsor this developer ❤

    License

    Read LICENSE file for detailed information.

    Install

    npm i doxygen2markdown

    DownloadsWeekly Downloads

    4

    Version

    0.0.14

    License

    GPL-3.0-or-later

    Unpacked Size

    177 kB

    Total Files

    41

    Last publish

    Collaborators

    • profiler4100