XMLDoc2Markdown 6.0.0

dotnet tool install --global XMLDoc2Markdown --version 6.0.0

This package contains a .NET tool you can call from the shell/command line.

dotnet new tool-manifest
                    

                            if you are setting up this repo

dotnet tool install --local XMLDoc2Markdown --version 6.0.0

This package contains a .NET tool you can call from the shell/command line.

#tool dotnet:?package=XMLDoc2Markdown&version=6.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

nuke :add-package XMLDoc2Markdown --version 6.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

XMLDoc2Markdown

Tool to generate markdown from C# XML documentation.

dotnet tool install -g XMLDoc2Markdown

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

dotnet xmldoc2md Sample.dll --output docs --platform github-pages --back-button

See complete documentation here.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.