XmlDocToMarkdownTransformer Class

Namespace
Kampute.DocToolkit.XmlDoc
Assembly
  • Kampute.DocToolkit.dll

Definition

Converts the text content of XML documentation comments into Markdown format using XSLT transformations.
public class XmlDocToMarkdownTransformer : XmlDocTransformer
Inheritance

Remarks

The XmlDocToMarkdownTransformer class transforms XML documentation comments into Markdown format, making it ideal for documentation that will be published on platforms that support Markdown such as GitHub, GitLab, Azure DevOps Wiki, Bitbucket, or any other Markdown-based documentation system.

By default, the transformer uses an embedded XSLT resource specifically designed for Markdown output. You can also provide a custom XSLT transformation if you need specialized Markdown formatting that adheres to particular Markdown flavors or extensions.

In addition to the standard capabilities, this transformer includes support for extended features through the XsltTextTools and XsltMarkdownTools extension methods, which provide specialized formatting for Markdown-specific elements beyond basic text processing.

Constructors

XmlDocToMarkdownTransformer()Initializes a new instance of the XmlDocToMarkdownTransformer class with the default XSLT transform.
XmlDocToMarkdownTransformer(XslCompiledTransform)Initializes a new instance of the XmlDocToMarkdownTransformer class with the specified XSLT transform.

See Also