MarkdownFormat.CreateMarkupWriter Method

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

Definition

Creates an instance of MarkupWriter class that wraps the specified writer for encoding content in Markdown format.
public override MarkupWriter CreateMarkupWriter(TextWriter writer, bool disposeWriter = false)

Parameters

writer TextWriter
The TextWriter to write the encoded content to.
disposeWriter bool optional
true if the wrapped writer should be disposed when the returned MarkupWriter is disposed; otherwise, false. The default is false.

Returns

MarkupWriter
A new instance of a MarkdownWriter object that wraps the specified writer.

Remarks

This implementation creates a MarkdownWriter instance that provides Markdown-specific formatting capabilities, such as proper syntax for headings, lists, code blocks, and other Markdown-specific elements.

The writer automatically handles Markdown requirements:

  • Escaping special Markdown characters (*, _, #, etc.) in regular text
  • Generating well-formed Markdown syntax for semantic document structures

It is the caller's responsibility to dispose the returned MarkupWriter instance to release any resources.