Class MarkdownReadOptions

Namespace

DocWright.Formats.Markdown

Assembly

DocWright.Formats.Markdown.dll

Format-specific settings for MarkdownReader.

public sealed class MarkdownReadOptions

Inheritance

object

MarkdownReadOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

These live on the reader rather than on DocumentReadOptions because the core seam never widens for a format — the same shape HtmlReadOptions, RtfReadOptions and ImageRenderOptions use.

Constructors

MarkdownReadOptions()

Fields

DefaultMaxNestingDepth

The default block-nesting limit. Block quotes and lists nest without bound in Markdown and cost one character per level, so a limit is a security property rather than a convenience — see MaxNestingDepth.

Properties

Encoding

Gets or sets the encoding to decode the input with. Null (the default) detects it: a byte-order mark first, then UTF-8.

Flavor

Gets or sets the dialect to parse. Defaults to GitHubFlavored.

KeepRawHtmlAsText

Gets or sets a value indicating whether raw HTML in the source is kept as literal text. True by default.

MapHeadingsToStyles

Gets or sets a value indicating whether h1–h6 map to the built-in Heading1–Heading6 style ids. True by default.

MaxNestingDepth

Gets or sets the maximum block-nesting depth. Exceeding it throws a ResourceLimitExceededException.

SkipYamlFrontMatter

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