Tool to generate markdown from C# XML documentation.
Total Downloads
155.0K
155,008
Published
Jun 9, 2026
4mo ago
Get Started
dotnet add package XMLDoc2Markdown --version 6.0.0
No framework information available.
README
XMLDoc2Markdown
Tool to generate markdown from C# XML documentation.
How to use
Install tool
dotnet tool install -g XMLDoc2Markdown
Generate documentation
dotnet xmldoc2md <src> [options]
| Argument | Description |
|---|---|
<src> |
DLL source path |
| Option | Description |
|---|---|
-o, --output <output> |
Output directory |
--index-page-name <index-page-name> |
Name of the index page [default: index] |
--examples-path <examples-path> |
Path to the code examples to insert in the documentation |
--platform <plain|github-pages|jekyll|gitlab-wiki|just-the-docs|docusaurus> |
Target documentation host. Presets link rewriting and front matter (override with the options below). [default: plain] |
--link-extension <md|none> |
Override the link file extension (md keeps .md, none strips it). Defaults to the platform preset. |
--link-prefix <relative|none> |
Override the link prefix (relative keeps ./, none strips it). Defaults to the platform preset. |
--back-button |
Add a back button on each page |
--member-accessibility-level <internal|private|protected|public> |
Minimum accessibility level of members to be documented. [default: protected] |
--structure <flat|tree> |
Documentation structure. [default: flat] |
--front-matter <none|jekyll|just-the-docs|docusaurus> |
Override the front matter preset emitted for a documentation system. Defaults to the platform preset. |
--front-matter-field <key=value> |
Extra front matter key=value pair, merged on top of the preset (repeatable). Value emitted verbatim. |
--version |
Show version information |
-?, -h, --help |
Show help and usage information |
Example
dotnet xmldoc2md Sample.dll --output docs --platform github-pages --back-button
See complete documentation here.
Downloads by Version
Similar & Alternative Packages
Hand-picked matching NuGet libraries based on tags & ecosystem
Depended On By
Find packages that declare this package as a dependency. NuGet does not provide a reverse-dependency endpoint, so candidates are checked on demand.
Adoption Assessment
Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.
No target framework metadata is available. Confirm compatibility in a representative project before standardising on this package.
Related Guides & Workflows
Learn how to evaluate, integrate, or audit this package in your .NET project.