Table of Contents

Property SkipYamlFrontMatter

Namespace
DocWright.Formats.Markdown
Assembly
DocWright.Formats.Markdown.dll

SkipYamlFrontMatter

Gets or sets a value indicating whether a leading YAML front-matter block delimited by --- is skipped. True by default.

public bool SkipYamlFrontMatter { get; set; }

Property Value

bool

Remarks

Front matter is not in CommonMark, and CommonMark reads --- as a thematic break or a setext underline — so a file with front matter parses, under the specification, as a rule followed by a paragraph of metadata. Skipping it is what every static-site generator does and what a caller means. It is reported (DXP2002), never dropped in silence, and this option turns it off for a caller who wants the literal reading.