GabrieleCocco / Vsxmd

VS XML documentation -> Markdown syntax.

Vsxmd

A MSBuild task to convert VS generated XML document to Markdown syntax.

This project is initially inspired from a gist. But in the later releases, the implementation is rewritten.

Features

• Provide full information from the XML documentation.
• Provide easy reading facilities - parameter table, link tooltip, etc.
• Provide table of contents and navigation links.
• Provide type and member anchors.
• Reference System types to MSDN packages.

Usage

• In Visual Studio, right click project name to open project properties window.
• Open Build tab, in Output section, check XML documentation file.
• Install Vsxmd package from NuGet.
• Build the project, then a .md file is generated next to the XML document.

Makrdown Path

The project property, DocumentationMarkdown, is used to specify the generated Markdown file path.

If not specified, it will be the same XML documentation file name with .md extension, under the same folder as the XML file.

API

This library provides the following public API to convert VS XML documentation to Markdown syntax programmatically.

• Converter : IConverter
  • string ToMarkdown()
  • static string ToMarkdown(document)

Example

Check this project's documentation file, Vsxmd.md, which is generated by this project.

Known Issues

The syntax for the list comment tag is not well defined. It will be skipped during render.

If you have ideas, please open an issue.

License

MIT License.