{"id":25073352,"url":"https://github.com/charlesdevandiere/xmldoc2md","last_synced_at":"2026-02-27T19:40:36.839Z","repository":{"id":37927229,"uuid":"222438403","full_name":"charlesdevandiere/xmldoc2md","owner":"charlesdevandiere","description":"Tool to generate markdown from C# XML documentation","archived":false,"fork":false,"pushed_at":"2025-09-01T11:42:35.000Z","size":71,"stargazers_count":56,"open_issues_count":11,"forks_count":19,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-05T22:09:26.925Z","etag":null,"topics":["documentation","documentation-generator","dotnet","markdown"],"latest_commit_sha":null,"homepage":"https://charlesdevandiere.github.io/xmldoc2md/","language":"C#","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/charlesdevandiere.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-18T11:57:32.000Z","updated_at":"2025-09-25T05:11:01.000Z","dependencies_parsed_at":"2024-07-25T06:34:40.323Z","dependency_job_id":"3ad525e6-5292-4889-93df-16d1068d285b","html_url":"https://github.com/charlesdevandiere/xmldoc2md","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/charlesdevandiere/xmldoc2md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesdevandiere%2Fxmldoc2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesdevandiere%2Fxmldoc2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesdevandiere%2Fxmldoc2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesdevandiere%2Fxmldoc2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charlesdevandiere","download_url":"https://codeload.github.com/charlesdevandiere/xmldoc2md/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesdevandiere%2Fxmldoc2md/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29910747,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"ssl_error","status_checked_at":"2026-02-27T19:37:41.463Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","documentation-generator","dotnet","markdown"],"created_at":"2025-02-06T23:19:33.840Z","updated_at":"2026-02-27T19:40:36.805Z","avatar_url":"https://github.com/charlesdevandiere.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XMLDoc2Markdown\n\nTool to generate markdown from C# XML documentation.\n\n[![Build Status](https://dev.azure.com/charlesdevandiere/charlesdevandiere/_apis/build/status/charlesdevandiere.xmldoc2md?branchName=master)](https://dev.azure.com/charlesdevandiere/charlesdevandiere/_build/latest?definitionId=2\u0026branchName=master)\n[![Nuget](https://img.shields.io/nuget/v/XMLDoc2Markdown.svg?color=blue\u0026logo=nuget)](https://www.nuget.org/packages/XMLDoc2Markdown)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=charlesdevandiere_xmldoc2md\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=charlesdevandiere_xmldoc2md)\n\n## How to use\n\n### Install tool\n\n```shell\ndotnet tool install -g XMLDoc2Markdown\n```\n\n### Generate documentation\n\n```shell\ndotnet xmldoc2md \u003csrc\u003e [options]\n```\n\n| Argument | Description |\n|---|---|\n| `\u003csrc\u003e` | DLL source path |\n\n| Option | Description |\n|---|---|\n| `-o, --output \u003coutput\u003e` | Output directory |\n| `--index-page-name \u003cindex-page-name\u003e` | Name of the index page [default: index] |\n| `--examples-path \u003cexamples-path\u003e` | Path to the code examples to insert in the documentation |\n| `--github-pages` | Remove '.md' extension from links for GitHub Pages |\n| `--gitlab-wiki` | Remove '.md' extension and './' prefix from links for gitlab wikis |\n| `--back-button` | Add a back button on each page |\n| `--member-accessibility-level \u003cinternal\\|private\\|protected\\|public\u003e` | Minimum accessibility level of members to be documented. [default: protected] |\n| `--structure \u003cflat\\|tree\u003e` | Documentation structure. [default: flat] |\n| `--version` | Show version information |\n| `-?, -h, --help` | Show help and usage information |\n\n#### Example\n\n```shell\ndotnet xmldoc2md Sample.dll --output docs --github-pages --back-button\n```\n\nSee complete documentation [here](https://charlesdevandiere.github.io/xmldoc2md/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlesdevandiere%2Fxmldoc2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharlesdevandiere%2Fxmldoc2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlesdevandiere%2Fxmldoc2md/lists"}