{"id":17998950,"url":"https://github.com/albin-johansson/doxy-to-md","last_synced_at":"2025-06-28T15:32:11.317Z","repository":{"id":131864097,"uuid":"465392830","full_name":"albin-johansson/doxy-to-md","owner":"albin-johansson","description":"Converts Doxygen XML output to Markdown files.","archived":false,"fork":false,"pushed_at":"2022-04-09T16:16:27.000Z","size":126,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T03:23:05.945Z","etag":null,"topics":["cli","cpp","documentation","doxygen","markdown","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/albin-johansson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-02T16:54:48.000Z","updated_at":"2024-08-02T12:53:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"98a652f0-f351-44e5-be94-144f04e5045b","html_url":"https://github.com/albin-johansson/doxy-to-md","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/albin-johansson/doxy-to-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albin-johansson%2Fdoxy-to-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albin-johansson%2Fdoxy-to-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albin-johansson%2Fdoxy-to-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albin-johansson%2Fdoxy-to-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/albin-johansson","download_url":"https://codeload.github.com/albin-johansson/doxy-to-md/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albin-johansson%2Fdoxy-to-md/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262452543,"owners_count":23313463,"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":["cli","cpp","documentation","doxygen","markdown","rust"],"created_at":"2024-10-29T22:09:20.007Z","updated_at":"2025-06-28T15:32:11.296Z","avatar_url":"https://github.com/albin-johansson.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doxy-to-md\n\nConverts Doxygen XML output to Markdown files.\n\n## Disclaimer\n\n[Centurion]: https://github.com/albin-johansson/centurion/\n\nThis tool was written for use by the [Centurion] project. It is not intended to perform perfect or 100% complete\nconversions from Doxygen to Markdown. The goal is to provide a good overview of the APIs with minimal manual work to get\nthe API documentation available in Markdown format, which can be used in documentation generators such as GitBook,\nmdBook, or Material for MkDocs.\n\n## Building\n\nThis tool is written in Rust, which makes is very easy to build the tool locally. All you need is the Rust toolchain.\n\nSimply clone and unzip the repository to somewhere on your machine and enter the following command in a shell, opened\nin the root directory of the repository.\n\n```shell\ncargo build --release\n```\n\nWhen the compilation is done, you should be able to locate the binary, called `doxy-to-md`, in `target/release`.\n\n## Usage\n\nThis tool processes the XML format emitted by Doxygen. However, Doxygen only emits HTML files by default, so you'll need\nto set `GENERATE_XML` to `YES` in your Doxyfile. Then, run Doxygen on your sources to produce the XML files.\n\nTo run the `doxy-to-md` program, you need to supply two arguments, `-i`/`--input-dir` and `-o`/`--output-dir`. The input\ndirectory is where `doxy-to-md` looks for the XML files produced by Doxygen. Subsequently, the output directory is where\nthe generated Markdown files will go.\n\nThe output directory will be created if it does not exist by the time `doxy-to-md` is executed.\n\n```shell\n./doxy-to-md -i path/to/doxygen/xml -o output/md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbin-johansson%2Fdoxy-to-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falbin-johansson%2Fdoxy-to-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbin-johansson%2Fdoxy-to-md/lists"}