YamlFrontMatterExtension Class

Extension to discard a YAML frontmatter at the beginning of a Markdown document.

public class YamlFrontMatterExtension : IMarkdownExtension
Implements

Constructors

NameDescription
YamlFrontMatterExtension()

YamlFrontMatterExtension()

public YamlFrontMatterExtension()

No documentation is available.

Properties

NameDescription
AllowInMiddleOfDocumentAllows the YamlFrontMatterBlock to appear in the middle of the markdown file.

AllowInMiddleOfDocument

YamlFrontMatterExtension.cs

Allows the YamlFrontMatterBlock to appear in the middle of the markdown file.

public bool AllowInMiddleOfDocument { get; set; }

Property value

bool

Methods

NameDescription
Setup(MarkdownPipeline, IMarkdownRenderer)Configures this extension for the specified pipeline stage.
Setup(MarkdownPipelineBuilder)Configures this extension for the specified pipeline stage.

Setup overloads

Setup(MarkdownPipeline, IMarkdownRenderer)

YamlFrontMatterExtension.cs

Configures this extension for the specified pipeline stage.

public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer)
Parameters
pipeline MarkdownPipeline
renderer IMarkdownRenderer

Setup(MarkdownPipelineBuilder)

YamlFrontMatterExtension.cs

Configures this extension for the specified pipeline stage.

public void Setup(MarkdownPipelineBuilder pipeline)
Parameters
pipeline MarkdownPipelineBuilder