Class MarkdownWriteOptions

Namespace: DocWright.Formats.Markdown

Assembly: DocWright.Formats.Markdown.dll

Format-specific settings for MarkdownWriter.

public sealed class MarkdownWriteOptions

Inheritance: object

MarkdownWriteOptions

Inherited Members: object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MarkdownWriteOptions()

Properties

BulletStyle: Gets or sets the bullet character. Defaults to Hyphen.

EmbedImagesAsDataUris: Gets or sets a value indicating whether an image is written as a data URI. False by default, in which case an image becomes a reference to a file name the caller is expected to write beside the document — and the bytes are reported as not emitted.

EmphasisStyle: Gets or sets the emphasis delimiter. Defaults to Asterisk.

Flavor: Gets or sets the dialect to write. Defaults to GitHubFlavored.

NewLine: Gets or sets the line ending. Defaults to "\n", which is what every Markdown tool writes and what keeps output identical across the four target frameworks.

TableStyle: Gets or sets how a table is written. Defaults to Pipe.

UseAtxHeadings: Gets or sets a value indicating whether a heading is written in the ATX form (# Heading). True by default; false writes the setext form for levels 1 and 2 and falls back to ATX for levels 3 to 6, which setext cannot express.