{"id":19936282,"url":"https://github.com/sourcey/moxygen","last_synced_at":"2025-04-12T16:36:14.809Z","repository":{"id":39068946,"uuid":"73318407","full_name":"sourcey/moxygen","owner":"sourcey","description":"Doxygen XML to Markdown converter","archived":false,"fork":false,"pushed_at":"2022-12-16T06:30:18.000Z","size":145,"stargazers_count":250,"open_issues_count":38,"forks_count":94,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-03T17:13:17.292Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sourcey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-09T20:24:05.000Z","updated_at":"2025-03-28T04:22:05.000Z","dependencies_parsed_at":"2023-01-29T10:15:46.999Z","dependency_job_id":null,"html_url":"https://github.com/sourcey/moxygen","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fmoxygen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fmoxygen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fmoxygen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fmoxygen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sourcey","download_url":"https://codeload.github.com/sourcey/moxygen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248597292,"owners_count":21130850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T23:24:50.105Z","updated_at":"2025-04-12T16:36:14.785Z","avatar_url":"https://github.com/sourcey.png","language":"JavaScript","funding_links":[],"categories":["Convert to Markdown Tools"],"sub_categories":["Source Code to Markdown"],"readme":"# Moxygen\n\nMoxygen is a Doxygen XML to Markdown converter for C++ developers who want a minimal and beautiful solution for documentating their projects.\n\nMoxygen is currently used in conjunction with GitBook to generate the API documentation for [LibSourcey](http://sourcey.com/libsourcey/).\n\n## Features\n\n* **Multi page output**: Output single or multiple files\n* **Internal linking**: Anchors in comments and function definitions are supported\n* **Markdown comments**: Markdown in Doxygen comments are rendered\n* **Doxygen groups**: Doxygen [grouping](http://www.doxygen.nl/manual/grouping.html) is supported for more organised documentation\n* **Custom templates**: Modify the core Markdown templates to add your own flavour\n* **Optional index**: Optionally render a top level index\n\n## Usage\n\n1. Add `GENERATE_XML=YES` to your `Doxyfile` first.\n2. Run `doxygen` to generate the XML documentation.\n3. Install `moxygen` like so: `npm install moxygen -g`.\n4. Run `moxygen` providing the folder location of the XML documentation as the first argument ie. `{OUTPUT_DIRECTORY}/xml`.  \n  ```\n  Usage: moxygen [options] \u003cdoxygen XML directory\u003e\n\n  Options:\n\n    -V, --version          output the version number\n    -o, --output \u003cfile\u003e    output file, must contain \"%s\" when using `groups` or `classes`\n    -g, --groups           output doxygen groups into separate files\n    -c, --classes          output doxygen classes into separate files\n    -p, --pages            output doxygen pages into separate files\n    -n, --noindex          disable generation of the index, ignored with `groups` or `classes`\n    -a, --anchors          add anchors to internal links\n    -H, --html-anchors     add html anchors to internal links\n    -l, --language \u003clang\u003e  programming language\n    -t, --templates \u003cdir\u003e  custom templates directory\n    -L, --logfile [file]   output log messages to file\n    -q, --quiet            quiet mode\n    -h, --help             output usage information\n  ```\n\n## Multi-page Output\n\nMoxygen supports the doxygen [groups](http://www.doxygen.nl/manual/grouping.html#modules) syntax for generating multi page documentation. Every [\\defgroup](http://www.doxygen.nl/manual/commands.html#cmddefgroup) in your source code will be parsed and output into a separate markdown file, with internal reference updated accordingly.\n\nExample:\n\n```\nmoxygen --anchors --groups --output api-%s.md /path/to/doxygen/xml\n```\n\n## Example\n\nTo get a feel for how Moxygen works you can play with the example which is located in the [example](/example) folder. The example contains:\n\n* Documented C++ example code\n* A `Doxyfile` file (for doxygen 1.8.13)\n* Pre-generated XML output in [example/xml](/example/xml)\n* Pre-generated output Markdown files in [example/doc](/example/doc)\n\nTo fully build the example, follow these steps (once you've installed `doxygen`. See **Development \u0026 Contribution**, below):\n\n1. Rebuild the XML: run `doxygen` from within the example folder.\n2. Rebuild the Moxygen output: from within this directory,\n\n```\nnode bin/moxygen.js --groups --pages --anchors --output=example/doc/api-%s.md example/xml\n```\n\n## Development \u0026 Contribution\n\nYou can develop this project as you would any other Node project:\n\n1. Clone this repo.\n2. `npm install` from this directory.\n\nThis project is tested through integration, by building the `example/`. To quickly test this project:\n\n1. Install `doxygen` (`brew install doxygen`, `choco install doxygen`, for example). Only must be done once per computer.\n2. `npm test` from this directory. This will run Doxygen on the `example/` and build the output.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcey%2Fmoxygen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsourcey%2Fmoxygen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcey%2Fmoxygen/lists"}