Xml2Doc.Cli 1.3.1

Xml2Doc.Cli

Command-line interface for Xml2Doc, part of the mod-posh organization.

Overview

Xml2Doc.exe converts C# XML documentation into Markdown using the Xml2Doc.Core engine. It’s perfect for developers or CI systems that want quick, repeatable Markdown docs from XML output without writing code.

Usage

# Per-type documentation
Xml2Doc.exe --xml .\bin\Release\net9.0\MyLib.xml --out .\docs

# Single combined file
Xml2Doc.exe --xml .\bin\Release\net9.0\MyLib.xml --out .\docs\api.md --single --file-names clean

Options

Example Config File

You can use a JSON file to define all options and simplify command-line usage:

xml2doc.json

{
  "Xml": "src/MyLib/bin/Release/net9.0/MyLib.xml",
  "Out": "docs/api.md",
  "Single": true,
  "FileNames": "clean",
  "RootNamespace": "MyCompany.MyProduct",
  "CodeLanguage": "csharp"
}

Run it with:

Xml2Doc.exe --config xml2doc.json

CLI flags always override values from the config file.