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 MarkdownConverterExample
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
| Name | Description |
|---|---|
| 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.csConverts CommonMark text to HTML.
ToHtml(string, MarkdownParseOptions?)
MarkdownConverter.csConverts Markdown text to HTML.
public static string ToHtml(string markdown, MarkdownParseOptions? parseOptions)Parameters
markdownstring- The text.
parseOptionsMarkdownParseOptions?- The extensions to read, or
nullforMarkdownParseOptions.Default.
Returns
Exceptions
ArgumentNullExceptionmarkdownisnull.
ToHtml(string, MarkdownParseOptions?, MarkdownHtmlRendererOptions?)
MarkdownConverter.csConverts Markdown text to HTML.
public static string ToHtml(string markdown, MarkdownParseOptions? parseOptions, MarkdownHtmlRendererOptions? rendererOptions)Parameters
markdownstring- The text.
parseOptionsMarkdownParseOptions?- The extensions to read, or
nullforMarkdownParseOptions.Default. rendererOptionsMarkdownHtmlRendererOptions?- How to write the HTML, or
nullforMarkdownHtmlRendererOptions.Default.
Returns
Exceptions
ArgumentNullExceptionmarkdownisnull.
ToPlainText overloads
ToPlainText(string)
MarkdownConverter.csConverts CommonMark text to plain text.
ToPlainText(string, MarkdownParseOptions?)
MarkdownConverter.csConverts Markdown text to plain text.
public static string ToPlainText(string markdown, MarkdownParseOptions? parseOptions)Parameters
markdownstring- The text.
parseOptionsMarkdownParseOptions?- The extensions to read, or
nullforMarkdownParseOptions.Default.
Returns
Exceptions
ArgumentNullExceptionmarkdownisnull.
ToPlainText(string, MarkdownParseOptions?, MarkdownHtmlRendererOptions?)
MarkdownConverter.csConverts Markdown text to plain text.
public static string ToPlainText(string markdown, MarkdownParseOptions? parseOptions, MarkdownHtmlRendererOptions? rendererOptions)Parameters
markdownstring- The text.
parseOptionsMarkdownParseOptions?- The extensions to read, or
nullforMarkdownParseOptions.Default. rendererOptionsMarkdownHtmlRendererOptions?- How to write the text, or
nullforMarkdownHtmlRendererOptions.Default.
Returns
Exceptions
ArgumentNullExceptionmarkdownisnull.