MarkdownConverter Class

Converts Markdown text to HTML or to plain text in one call: it parses the text with MarkdownSyntaxTree.ParseText, then renders the tree with MarkdownHtmlRenderer or MarkdownPlainTextRenderer.

public static class MarkdownConverter

Example

Assert.Equal("<p>Some <strong>bold</strong> text</p>\n", MarkdownConverter.ToHtml("Some **bold** text"));
Assert.Equal("<p><del>Old</del> new</p>\n", MarkdownConverter.ToHtml("~~Old~~ new", MarkdownParseOptions.GitHubFlavored));
Assert.Equal("Some bold text\n", MarkdownConverter.ToPlainText("Some **bold** text"));

Methods

NameDescription
ToHtml(string)Converts CommonMark text to HTML.
ToHtml(string, MarkdownParseOptions?)Converts Markdown text to HTML.
ToHtml(string, MarkdownParseOptions?, MarkdownHtmlRendererOptions?)Converts Markdown text to HTML.
ToPlainText(string)Converts CommonMark text to plain text.
ToPlainText(string, MarkdownParseOptions?)Converts Markdown text to plain text.
ToPlainText(string, MarkdownParseOptions?, MarkdownHtmlRendererOptions?)Converts Markdown text to plain text.

ToHtml overloads

ToHtml(string)

MarkdownConverter.cs

Converts CommonMark text to HTML.

public static string ToHtml(string markdown)
Parameters
markdown string
Returns

string

Exceptions
ArgumentNullException
markdown is null.

ToHtml(string, MarkdownParseOptions?)

MarkdownConverter.cs

Converts Markdown text to HTML.

public static string ToHtml(string markdown, MarkdownParseOptions? parseOptions)
Parameters
markdown string
The text.
parseOptions MarkdownParseOptions?
The extensions to read, or null for MarkdownParseOptions.Default.
Returns

string

Exceptions
ArgumentNullException
markdown is null.

ToHtml(string, MarkdownParseOptions?, MarkdownHtmlRendererOptions?)

MarkdownConverter.cs

Converts Markdown text to HTML.

public static string ToHtml(string markdown, MarkdownParseOptions? parseOptions, MarkdownHtmlRendererOptions? rendererOptions)
Parameters
markdown string
The text.
parseOptions MarkdownParseOptions?
The extensions to read, or null for MarkdownParseOptions.Default.
rendererOptions MarkdownHtmlRendererOptions?
How to write the HTML, or null for MarkdownHtmlRendererOptions.Default.
Returns

string

Exceptions
ArgumentNullException
markdown is null.

ToPlainText overloads

ToPlainText(string)

MarkdownConverter.cs

Converts CommonMark text to plain text.

public static string ToPlainText(string markdown)
Parameters
markdown string
Returns

string

Exceptions
ArgumentNullException
markdown is null.

ToPlainText(string, MarkdownParseOptions?)

MarkdownConverter.cs

Converts Markdown text to plain text.

public static string ToPlainText(string markdown, MarkdownParseOptions? parseOptions)
Parameters
markdown string
The text.
parseOptions MarkdownParseOptions?
The extensions to read, or null for MarkdownParseOptions.Default.
Returns

string

Exceptions
ArgumentNullException
markdown is null.

ToPlainText(string, MarkdownParseOptions?, MarkdownHtmlRendererOptions?)

MarkdownConverter.cs

Converts Markdown text to plain text.

public static string ToPlainText(string markdown, MarkdownParseOptions? parseOptions, MarkdownHtmlRendererOptions? rendererOptions)
Parameters
markdown string
The text.
parseOptions MarkdownParseOptions?
The extensions to read, or null for MarkdownParseOptions.Default.
rendererOptions MarkdownHtmlRendererOptions?
How to write the text, or null for MarkdownHtmlRendererOptions.Default.
Returns

string

Exceptions
ArgumentNullException
markdown is null.