MarkdownFormat Class

Namespace
Kampute.DocToolkit.Formatters
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a documentation formatter that generates Markdown content.
public class MarkdownFormat : DocFormatter, IXmlDocReferenceAccessor
Inheritance
Implements

Remarks

The MarkdownFormat class provides functionality for generating documentation in Markdown format. It handles the transformation of XML documentation comments to Markdown, proper encoding of Markdown special characters, and supports various file extensions commonly associated with Markdown files.

Use this formatter when you need to generate documentation for platforms that support Markdown, such as GitHub, GitLab, Azure DevOps Wiki, or other Markdown-compatible documentation systems.

Constructors

MarkdownFormat()Initializes a new instance of the MarkdownFormat class.
MarkdownFormat(string)Initializes a new instance of the MarkdownFormat class with the specified file extension for the Markdown files.

Properties

XmlDocTransformerGets the XML documentation transformer for the Markdown format.

Methods

CreateMarkupWriter(TextWriter, bool)Creates an instance of MarkupWriter class that wraps the specified writer for encoding content in Markdown format.
CreateMinifier(TextWriter)Creates a TextWriter instance that wraps the specified writer to minimize the content for Markdown format.
Encode(ReadOnlySpan<char>, TextWriter)Encodes special Markdown characters in the specified text and writes the encoded content to the specified writer.

Explicit Interface Implementations

IXmlDocReferenceAccessor.ReferenceResolverGets or sets the reference resolver for resolving references in XML documentation comments.

See Also