MarkdownPipelineBuilder Class

Definition

Namespace Markdig

Assembly Markdig.dll

Inherits Object

Show inherited members (7)

This class allows to modify the pipeline to parse and render a Markdown document.

public class MarkdownPipelineBuilder

Remarks

NOTE: A pipeline is not thread-safe.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (1)

MarkdownPipelineBuilder()Initializes a new instance of the MarkdownPipeline class.

Properties (6)

BlockParsersGets the block parsers.

DebugLogGets or sets the debug log.

ExtensionsGets the register extensions.

InlineParsersGets the inline parsers.

PreciseSourceLocationGets or sets a value indicating whether to enable precise source location (slower parsing but accurate position for block and inline elements)

TrackTriviaTrue to parse trivia such as whitespace, extra heading characters and unescaped string values.

Methods (1)

Build()Builds a pipeline from this instance. Once the pipeline is build, it cannot be modified.

Events (1)

DocumentProcessedOccurs when a document has been processed after the Parse(String, MarkdownPipeline?, MarkdownParserContext?) method.

Extensions (40)

Configure(MarkdownPipelineBuilder, String?)Configures the pipeline using a string that defines the extensions to activate.

ConfigureNewLine(MarkdownPipelineBuilder, String)Configures the string to be used for line-endings, when writing.

DisableHeadings(MarkdownPipelineBuilder)Disables parsing of ATX and Setex headings

DisableHtml(MarkdownPipelineBuilder)This will disable the HTML support in the markdown processor (for constraint/safe parsing).

EnableTrackTrivia(MarkdownPipelineBuilder)Enables parsing and tracking of trivia characters

Use<TExtension>(MarkdownPipelineBuilder, TExtension)Adds the specified extension instance to the extensions collection.

Use<TExtension>(MarkdownPipelineBuilder)Adds the specified extension to the extensions collection.

UseAbbreviations(MarkdownPipelineBuilder)Uses the custom abbreviation extension.

UseAdvancedExtensions(MarkdownPipelineBuilder)Uses all extensions except the BootStrap, Emoji, SmartyPants and soft line as hard line breaks extensions.

UseAlertBlocks(MarkdownPipelineBuilder, Action<HtmlRenderer, StringSlice>?)Uses this extension to enable alert blocks.

UseAutoIdentifiers(MarkdownPipelineBuilder, AutoIdentifierOptions)Uses the auto-identifier extension.

UseAutoLinks(MarkdownPipelineBuilder, AutoLinkOptions?)Uses this extension to enable autolinks from text `http://`, `https://`, `ftp://`, `mailto:`, `www.xxx.yyy`

UseBootstrap(MarkdownPipelineBuilder)Uses the bootstrap extension.

UseCitations(MarkdownPipelineBuilder)Uses the cite extension.

UseCustomContainers(MarkdownPipelineBuilder)Uses the custom container extension.

UseDefinitionLists(MarkdownPipelineBuilder)Uses the definition lists extension.

UseDiagrams(MarkdownPipelineBuilder)Uses the diagrams extension

UseEmojiAndSmiley(MarkdownPipelineBuilder, EmojiMapping)Uses the emojis and smileys extension.

UseEmojiAndSmiley(MarkdownPipelineBuilder, Boolean)Uses the emojis and smileys extension.

UseEmphasisExtras(MarkdownPipelineBuilder, EmphasisExtraOptions)Uses the strikethrough superscript, subscript, inserted and marked text extensions.

UseFigures(MarkdownPipelineBuilder)Uses the figure extension.

UseFooters(MarkdownPipelineBuilder)Uses the footer extension.

UseFootnotes(MarkdownPipelineBuilder)Uses the footnotes extension.

UseGenericAttributes(MarkdownPipelineBuilder)Uses the generic attributes extension.

UseGlobalization(MarkdownPipelineBuilder)Adds support for right-to-left content by adding appropriate html attribtues.

UseGridTables(MarkdownPipelineBuilder)Uses the grid table extension.

UseJiraLinks(MarkdownPipelineBuilder, JiraLinkOptions)Automatically link references to JIRA issues

UseListExtras(MarkdownPipelineBuilder)Uses the list extra extension to add support for `a.`, `A.`, `i.` and `I.` ordered list items.

UseMathematics(MarkdownPipelineBuilder)Uses the math extension.

UseMediaLinks(MarkdownPipelineBuilder, MediaOptions?)Uses the media extension.

UseNonAsciiNoEscape(MarkdownPipelineBuilder)Uses this extension to disable URI escape with % characters for non-US-ASCII characters in order to workaround a bug under IE/Edge with local file links containing non US-ASCII chars. DO NOT USE OTHERWISE.

UsePipeTables(MarkdownPipelineBuilder, PipeTableOptions?)Uses the pipe table extension.

UsePragmaLines(MarkdownPipelineBuilder)Uses pragma lines to output span with an id containing the line number (pragma-line#line_number_zero_based`)

UsePreciseSourceLocation(MarkdownPipelineBuilder)Uses precise source code location (useful for syntax highlighting).

UseReferralLinks(MarkdownPipelineBuilder, String[])Performs the use referral links operation.

UseSelfPipeline(MarkdownPipelineBuilder, String, String?)Uses the self pipeline extension that will detect the pipeline to use from the markdown input that contains a special tag. See SelfPipelineExtension

UseSmartyPants(MarkdownPipelineBuilder, SmartyPantOptions?)Uses the SmartyPants extension.

UseSoftlineBreakAsHardlineBreak(MarkdownPipelineBuilder)Uses the softline break as hardline break extension

UseTaskLists(MarkdownPipelineBuilder)Uses the task list extension.

UseYamlFrontMatter(MarkdownPipelineBuilder)Uses YAML frontmatter extension that will parse a YAML frontmatter into the MarkdownDocument. Note that they are not rendered by any default HTML renderer.