Xml2Doc.MSBuild 1.3.1

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Xml2Doc.MSBuild --version 1.3.1
                    


                    

                
NuGet\Install-Package Xml2Doc.MSBuild -Version 1.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Xml2Doc.MSBuild" Version="1.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Xml2Doc.MSBuild" Version="1.3.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Xml2Doc.MSBuild" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Xml2Doc.MSBuild --version 1.3.1
                    


                    

                
#r "nuget: Xml2Doc.MSBuild, 1.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Xml2Doc.MSBuild@1.3.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Xml2Doc.MSBuild&version=1.3.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Xml2Doc.MSBuild&version=1.3.1
                    


                            Install as a Cake Tool

Xml2Doc.MSBuild

MSBuild integration for Xml2Doc, part of the mod-posh organization.

Overview

Xml2Doc.MSBuild adds automatic documentation generation to your build process. When enabled, it uses Xml2Doc.Core to convert the compiler-generated XML documentation into Markdown after each successful build.

Setup

Add this to your project file:

<ItemGroup>
  <PackageReference Include="Xml2Doc.MSBuild" Version="1.1.0" PrivateAssets="all" />
</ItemGroup>

Optional MSBuild Properties

Property Description
Xml2Doc_Enabled Enables or disables Markdown generation (default: true)
Xml2Doc_SingleFile Generates one combined Markdown file
Xml2Doc_OutputFile Target file when single-file mode is used
Xml2Doc_OutputDir Target directory when generating per-type docs
Xml2Doc_FileNameMode verbatim or clean (controls generic name formatting)
Xml2Doc_RootNamespaceToTrim Optional namespace prefix to trim
Xml2Doc_CodeBlockLanguage Code block language (csharp by default)

Example Configuration

<PropertyGroup>
  <Xml2Doc_SingleFile>true</Xml2Doc_SingleFile>
  <Xml2Doc_OutputFile>$(ProjectDir)\docs\api.md</Xml2Doc_OutputFile>
  <Xml2Doc_FileNameMode>clean</Xml2Doc_FileNameMode>
  <Xml2Doc_RootNamespaceToTrim>MyCompany.MyProduct</Xml2Doc_RootNamespaceToTrim>
</PropertyGroup>
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Xml2Doc.MSBuild:

Package Downloads
Yaml2Doc.Markdown

Renderer library that converts the neutral pipeline model into human-friendly Markdown documentation.
Yaml2Doc.Core

Core library for parsing pipeline YAML into a neutral model for documentation.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.4.0-preview.98-g5ab3c0c 38 3/15/2026
1.4.0-preview.97-g6b55cdc 34 3/15/2026
1.4.0-preview.96-gd4b8414 38 3/15/2026
1.4.0-preview.95-g36489cc 35 3/15/2026
1.4.0-preview.94-g95a0d96 38 3/15/2026
1.4.0-preview.93-g8d985ca 36 3/15/2026
1.4.0-preview.92-g16d5460 39 3/15/2026
1.4.0-preview.91-gdc7994e 43 3/14/2026
1.4.0-preview.90-g773c9bc 42 3/14/2026
1.4.0-preview.89-g412955a 43 3/14/2026
1.4.0-preview.88-gd4339e3 38 3/14/2026
1.4.0-preview.87-g762e834 43 3/14/2026
1.4.0-preview.86-g10fb1f6 269 12/17/2025
1.4.0-preview.85-g20398c2 249 12/17/2025
1.4.0-preview.84-g14ae0ae 253 12/17/2025
1.4.0-preview.83-g7ca4dad 249 12/17/2025
1.4.0-preview.82-gccf3c5b 257 12/17/2025
1.4.0-preview.81-ga03f733 273 12/17/2025
1.4.0-preview.80-g111a6ac 277 11/7/2025
1.3.1 311 10/26/2025
Loading failed