UseGitHubExtensions(MarkdownPipelineBuilder, MarkdownExtensionsOptions?) Method

Definition

Assembly MarkView.Avalonia.dll

Enables the Markdig extensions that make a document render as it does on GitHub: pipe tables, task lists, strikethrough (text and text), autolinks, emoji shortcodes, alerts (> [!NOTE]), footnotes, CJK-friendly emphasis, hidden YAML front matter, collapsible HTML <details> blocks (see UseHtmlDetails(MarkdownPipelineBuilder)) and the HTML elements READMEs use, such as centered headers, badges and <kbd> (see UseHtmlSubset(MarkdownPipelineBuilder)). This is the pipeline a MarkdownViewer uses when none is set. Math and Mermaid diagrams come from their own packages (UseMath(), UseMermaid()).

public static MarkdownPipelineBuilder UseGitHubExtensions(this MarkdownPipelineBuilder builder, MarkdownExtensionsOptions? options = null)

Parameters

builder
Markdig.MarkdownPipelineBuilder

The pipeline builder.

options
MarkdownExtensionsOptions

Options for the extensions enabled by this method. See MarkdownExtensionsOptions.

Returns

Markdig.MarkdownPipelineBuilder