MarkdownExtensions Class
Provides extension methods for MarkdownPipelineBuilder to enable several Markdown extensions.
public static class MarkdownExtensionsMethods
| Name | Description |
|---|---|
| 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) | Adds the specified extension to the extensions collection. |
| Use<TExtension>(MarkdownPipelineBuilder, TExtension) | Adds the specified extension instance 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>?, bool) | 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. |
| UseCjkFriendlyEmphasis(MarkdownPipelineBuilder) | Enables CJK-friendly emphasis. ** around punctuation in CJK text will be much more likely to be parsed as emphasis as intended. |
| 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, bool) | 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, Func<string, bool>?) | 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. |
| 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. |
Configure(MarkdownPipelineBuilder, string?)
MarkdownExtensions.csConfigures the pipeline using a string that defines the extensions to activate.
public static MarkdownPipelineBuilder Configure(this MarkdownPipelineBuilder pipeline, string? extensions)Parameters
pipelineMarkdownPipelineBuilder- The pipeline (e.g: advanced for
MarkdownExtensions.UseAdvancedExtensions, pipetables+gridtables forMarkdownExtensions.UsePipeTablesandMarkdownExtensions.UseGridTables extensionsstring?- The extensions to activate as a string
Returns
MarkdownPipelineBuilder The modified pipeline
ConfigureNewLine(MarkdownPipelineBuilder, string)
MarkdownExtensions.csConfigures the string to be used for line-endings, when writing.
public static MarkdownPipelineBuilder ConfigureNewLine(this MarkdownPipelineBuilder pipeline, string newLine)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
newLinestring- The string to be used for line-endings.
Returns
MarkdownPipelineBuilder The modified pipeline
DisableHeadings(MarkdownPipelineBuilder)
MarkdownExtensions.csDisables parsing of ATX and Setex headings
public static MarkdownPipelineBuilder DisableHeadings(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
DisableHtml(MarkdownPipelineBuilder)
MarkdownExtensions.csThis will disable the HTML support in the markdown processor (for constraint/safe parsing).
public static MarkdownPipelineBuilder DisableHtml(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
EnableTrackTrivia(MarkdownPipelineBuilder)
MarkdownExtensions.csEnables parsing and tracking of trivia characters
public static MarkdownPipelineBuilder EnableTrackTrivia(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder he modified pipeline
Use overloads
Use<TExtension>(MarkdownPipelineBuilder)
MarkdownExtensions.csAdds the specified extension to the extensions collection.
public static MarkdownPipelineBuilder Use<TExtension>(this MarkdownPipelineBuilder pipeline) where TExtension : class, IMarkdownExtension, new()Type parameters
TExtension- The type of the extension.
Parameters
pipelineMarkdownPipelineBuilder
Returns
MarkdownPipelineBuilder The instance of MarkdownPipelineBuilder
Use<TExtension>(MarkdownPipelineBuilder, TExtension)
MarkdownExtensions.csAdds the specified extension instance to the extensions collection.
public static MarkdownPipelineBuilder Use<TExtension>(this MarkdownPipelineBuilder pipeline, TExtension extension) where TExtension : class, IMarkdownExtensionType parameters
TExtension- The type of the extension.
Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
extensionTExtension- The instance of the extension to be added.
Returns
MarkdownPipelineBuilder The modified pipeline
UseAbbreviations(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the custom abbreviation extension.
public static MarkdownPipelineBuilder UseAbbreviations(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseAdvancedExtensions(MarkdownPipelineBuilder)
MarkdownExtensions.csUses all extensions except the BootStrap, Emoji, SmartyPants and soft line as hard line breaks extensions.
public static MarkdownPipelineBuilder UseAdvancedExtensions(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseAlertBlocks(MarkdownPipelineBuilder, Action<HtmlRenderer, StringSlice>?, bool)
MarkdownExtensions.csUses this extension to enable alert blocks.
public static MarkdownPipelineBuilder UseAlertBlocks(this MarkdownPipelineBuilder pipeline, Action<HtmlRenderer, StringSlice>? renderKind = null, bool allowNestedAlerts = false)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
renderKindAction<HtmlRenderer, StringSlice>?- Replace the default renderer for the kind with a custom renderer.
allowNestedAlertsbool- Allow alerts to be nested inside other blocks (e.g. inside a blockquote or a list item). Alerts inside another alert are never allowed. Default is
false.
Returns
MarkdownPipelineBuilder The modified pipeline
UseAutoIdentifiers(MarkdownPipelineBuilder, AutoIdentifierOptions)
MarkdownExtensions.csUses the auto-identifier extension.
public static MarkdownPipelineBuilder UseAutoIdentifiers(this MarkdownPipelineBuilder pipeline, AutoIdentifierOptions options = AutoIdentifierOptions.Default)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
optionsAutoIdentifierOptions- The options.
Returns
MarkdownPipelineBuilder The modified pipeline
UseAutoLinks(MarkdownPipelineBuilder, AutoLinkOptions?)
MarkdownExtensions.csUses this extension to enable autolinks from text `http://`, `https://`, `ftp://`, `mailto:`, `www.xxx.yyy`
public static MarkdownPipelineBuilder UseAutoLinks(this MarkdownPipelineBuilder pipeline, AutoLinkOptions? options = null)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
optionsAutoLinkOptions?- The options.
Returns
MarkdownPipelineBuilder The modified pipeline
UseBootstrap(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the bootstrap extension.
public static MarkdownPipelineBuilder UseBootstrap(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseCitations(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the cite extension.
public static MarkdownPipelineBuilder UseCitations(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseCjkFriendlyEmphasis(MarkdownPipelineBuilder)
MarkdownExtensions.csEnables CJK-friendly emphasis. ** around punctuation in CJK text will be much more likely to be parsed as emphasis as intended.
public static MarkdownPipelineBuilder UseCjkFriendlyEmphasis(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline
Returns
MarkdownPipelineBuilder The modified pipeline
UseCustomContainers(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the custom container extension.
public static MarkdownPipelineBuilder UseCustomContainers(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseDefinitionLists(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the definition lists extension.
public static MarkdownPipelineBuilder UseDefinitionLists(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseDiagrams(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the diagrams extension
public static MarkdownPipelineBuilder UseDiagrams(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseEmojiAndSmiley overloads
UseEmojiAndSmiley(MarkdownPipelineBuilder, EmojiMapping)
MarkdownExtensions.csUses the emojis and smileys extension.
public static MarkdownPipelineBuilder UseEmojiAndSmiley(this MarkdownPipelineBuilder pipeline, EmojiMapping customEmojiMapping)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
customEmojiMappingEmojiMapping- Enable customization of the emojis and smileys mapping.
Returns
MarkdownPipelineBuilder The modified pipeline
UseEmojiAndSmiley(MarkdownPipelineBuilder, bool)
MarkdownExtensions.csUses the emojis and smileys extension.
public static MarkdownPipelineBuilder UseEmojiAndSmiley(this MarkdownPipelineBuilder pipeline, bool enableSmileys = true)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
enableSmileysbool- Enable smileys in addition to emoji shortcodes,
trueby default.
Returns
MarkdownPipelineBuilder The modified pipeline
UseEmphasisExtras(MarkdownPipelineBuilder, EmphasisExtraOptions)
MarkdownExtensions.csUses the strikethrough superscript, subscript, inserted and marked text extensions.
public static MarkdownPipelineBuilder UseEmphasisExtras(this MarkdownPipelineBuilder pipeline, EmphasisExtraOptions options = EmphasisExtraOptions.Default)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
optionsEmphasisExtraOptions- The options to enable.
Returns
MarkdownPipelineBuilder The modified pipeline
UseFigures(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the figure extension.
public static MarkdownPipelineBuilder UseFigures(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseFootnotes(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the footnotes extension.
public static MarkdownPipelineBuilder UseFootnotes(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseGenericAttributes(MarkdownPipelineBuilder, Func<string, bool>?)
MarkdownExtensions.csUses the generic attributes extension.
public static MarkdownPipelineBuilder UseGenericAttributes(this MarkdownPipelineBuilder pipeline, Func<string, bool>? attributeFilter = null)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
attributeFilterFunc<string, bool>?- Decides whether an attribute parsed from the Markdown (other than the id and the classes) is written to the HTML. When
null, the filter is left unchanged: by default,GenericAttributesExtension.IsSafeAttributeNameremoves the event handlers and the attributes that hold a URL.
Returns
MarkdownPipelineBuilder The modified pipeline
UseGlobalization(MarkdownPipelineBuilder)
MarkdownExtensions.csAdds support for right-to-left content by adding appropriate html attribtues.
public static MarkdownPipelineBuilder UseGlobalization(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline
Returns
MarkdownPipelineBuilder The modified pipeline
UseGridTables(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the grid table extension.
public static MarkdownPipelineBuilder UseGridTables(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseJiraLinks(MarkdownPipelineBuilder, JiraLinkOptions)
MarkdownExtensions.csAutomatically link references to JIRA issues
public static MarkdownPipelineBuilder UseJiraLinks(this MarkdownPipelineBuilder pipeline, JiraLinkOptions options)Parameters
pipelineMarkdownPipelineBuilder- The pipeline
optionsJiraLinkOptions- Set of required options
Returns
MarkdownPipelineBuilder The modified pipeline
UseListExtras(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the list extra extension to add support for `a.`, `A.`, `i.` and `I.` ordered list items.
public static MarkdownPipelineBuilder UseListExtras(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseMathematics(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the math extension.
public static MarkdownPipelineBuilder UseMathematics(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseMediaLinks(MarkdownPipelineBuilder, MediaOptions?)
MarkdownExtensions.csUses the media extension.
public static MarkdownPipelineBuilder UseMediaLinks(this MarkdownPipelineBuilder pipeline, MediaOptions? options = null)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
optionsMediaOptions?- The options.
Returns
MarkdownPipelineBuilder The modified pipeline
UseNonAsciiNoEscape(MarkdownPipelineBuilder)
MarkdownExtensions.csUses 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.
public static MarkdownPipelineBuilder UseNonAsciiNoEscape(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UsePipeTables(MarkdownPipelineBuilder, PipeTableOptions?)
MarkdownExtensions.csUses the pipe table extension.
public static MarkdownPipelineBuilder UsePipeTables(this MarkdownPipelineBuilder pipeline, PipeTableOptions? options = null)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
optionsPipeTableOptions?- The options.
Returns
MarkdownPipelineBuilder The modified pipeline
UsePragmaLines(MarkdownPipelineBuilder)
MarkdownExtensions.csUses pragma lines to output span with an id containing the line number (pragma-line#line_number_zero_based`)
public static MarkdownPipelineBuilder UsePragmaLines(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UsePreciseSourceLocation(MarkdownPipelineBuilder)
MarkdownExtensions.csUses precise source code location (useful for syntax highlighting).
public static MarkdownPipelineBuilder UsePreciseSourceLocation(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseReferralLinks(MarkdownPipelineBuilder, string[])
MarkdownExtensions.csPerforms the use referral links operation.
public static MarkdownPipelineBuilder UseReferralLinks(this MarkdownPipelineBuilder pipeline, params string[] rels)UseSmartyPants(MarkdownPipelineBuilder, SmartyPantOptions?)
MarkdownExtensions.csUses the SmartyPants extension.
public static MarkdownPipelineBuilder UseSmartyPants(this MarkdownPipelineBuilder pipeline, SmartyPantOptions? options = null)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
optionsSmartyPantOptions?- The options.
Returns
MarkdownPipelineBuilder The modified pipeline
UseSoftlineBreakAsHardlineBreak(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the softline break as hardline break extension
public static MarkdownPipelineBuilder UseSoftlineBreakAsHardlineBreak(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseTaskLists(MarkdownPipelineBuilder)
MarkdownExtensions.csUses the task list extension.
public static MarkdownPipelineBuilder UseTaskLists(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline
UseYamlFrontMatter(MarkdownPipelineBuilder)
MarkdownExtensions.csUses YAML frontmatter extension that will parse a YAML frontmatter into the MarkdownDocument. Note that they are not rendered by any default HTML renderer.
public static MarkdownPipelineBuilder UseYamlFrontMatter(this MarkdownPipelineBuilder pipeline)Parameters
pipelineMarkdownPipelineBuilder- The pipeline.
Returns
MarkdownPipelineBuilder The modified pipeline