XMLDoc2Markdown

Tool to generate markdown from C# XML documentation.

See sample generated documentation here.

How to use

Install tool

dotnet tool install -g XMLDoc2Markdown

Generate documentation

xmldoc2md <DLL_SOURCE_PATH> <OUTPUT_DIRECTORY>

Example

xmldoc2md Sample.dll docs

Insert code example

You can insert custom code example into the documentation.

Create one file for each examples. Give them the full name of corresponding type, property, method,…

Add the CLI option: --examples-path with the path to examples files.

Examples

MyClassLib.MyClass.md

## Example

Lorem ipsum...

```csharp
new MyClass();
```

MyClassLib.MyClass.MyProperty.md

#### Example

Lorem ipsum...

```csharp
foo.MyProperty = "foo";
```

MyClassLib.MyClass.MyMethod(System.String).md

#### Example

Lorem ipsum...

```csharp
foo.MyMethod("foo");
```

MyClassLib.MyClass.#ctor.md

#### Example

Lorem ipsum...

```csharp
new MyClass();
```

Display command line help

xmldoc2md -h

Usage: xmldoc2md [arguments] [options]

Arguments:
  src  DLL source path
  out  Output directory

Options:
  -v|--version       Show version information
  -?|-h|--help       Show help information
  --index-page-name  Name of the index page (default: "index")
  --examples-path    Path to the code examples to insert in the documentation
  --github-pages     Remove '.md' extension from links for GitHub Pages
  --gitlab-wiki      Remove '.md' extension and './' prefix from links for gitlab wikis
  --back-button      Add a back button on each page