Skip to main content

MarkdownSerializerOptions Class

Definition

Assembly:Avalonia.Controls.Markdown
Package:Avalonia.Controls.Markdown

Formatting choices for markdown output produced by Avalonia.Controls.Documents.Serialization.Markdown.MarkdownSerializer.Serialize(Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot,System.IO.Stream,System.Threading.CancellationToken). These control the canonical spellings the writer uses for syntax the document model does not preserve (delimiters, markers, fences); document content itself is unaffected.

public class MarkdownSerializerOptions

Inheritance: object -> MarkdownSerializerOptions

Constructors

NameDescription
MarkdownSerializerOptionsNo summary available.

MarkdownSerializerOptions Constructor

public MarkdownSerializerOptions()

Properties

NameDescription
BulletMarkerBullet list marker. Valid values: -, +, *.
DefaultThe default options: - bullets, * emphasis, backtick fences, . ordered delimiter, backslash hard breaks.
EmphasisCharEmphasis delimiter for bold and italic. Valid values: *, _.
FenceCharCode fence character. Valid values: backtick, ~.
HardBreakSpelling used for hard line breaks.
OrderedDelimiterDelimiter after ordered list numbers. Valid values: ., ).

BulletMarker Property

Bullet list marker. Valid values: -, +, *.

public char BulletMarker { get; set; }

Default Property

The default options: - bullets, * emphasis, backtick fences, . ordered delimiter, backslash hard breaks.

public Avalonia.Controls.Documents.Serialization.Markdown.MarkdownSerializerOptions Default { get; set; }

EmphasisChar Property

Emphasis delimiter for bold and italic. Valid values: *, _.

public char EmphasisChar { get; set; }

FenceChar Property

Code fence character. Valid values: backtick, ~.

public char FenceChar { get; set; }

HardBreak Property

Spelling used for hard line breaks.

public Avalonia.Controls.Documents.Serialization.Markdown.MarkdownHardBreak HardBreak { get; set; }

OrderedDelimiter Property

Delimiter after ordered list numbers. Valid values: ., ).

public char OrderedDelimiter { get; set; }