Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 6.64 KB

index.md

File metadata and controls

66 lines (48 loc) · 6.64 KB

MdSerializationOptions Class

Namespace: Grynwald.MarkdownGenerator
Assembly: Grynwald.MarkdownGenerator

Encapsulates settings that control how a document is serialized. A instance of MdSerializationOptions can be passed to the ToString overloads in MdBlock, MdSpan and MdDocument as well as the Save() method of MdDocument

public class MdSerializationOptions : ICloneable

Inheritance: object → MdSerializationOptions

Implements: ICloneable

Constructors

Name Description
MdSerializationOptions()

Fields

Name Description
Default

Properties

Name Description
BulletListStyle Gets or sets the style for bullet list items. Default value: Dash.
CodeBlockStyle Gets or sets the style of code blocks. Default value: Backtick.
EmphasisStyle Gets or sets the style for emphasized and strongly emphasized text. Default value: Asterisk.
HeadingAnchorStyle Gets or sets if anchors for headings are to be included in the output. Default value: None
HeadingStyle Gets or sets the style for headings. Default value: Atx.
MaxLineLength Gets or sets the maximum length of a line in the output. When set to a value greater than 0, line breaks will be inserted after the specified number of characters when possible. Default value: -1 (no line length limitation)
MinimumListIndentationWidth Gets or sets the minimum number of characters to use for indenting list items in multi-level lists (compared to items of the outer list level). The value indicates a minimum indentation. List items are always indented at least by the length of the list marker. Default value: 2
OrderedListStyle Gets or sets the style for ordered list items. Default value: Dot.
TableStyle Gets or sets the style for tables. Default value: GFM.
TextFormatter Gets or sets the implementation to use for escaping text when saving a Markdown document.
ThematicBreakStyle Gets or sets the style to use for thematic breaks. Default value: Underscore.

Methods

Name Description
Clone() Creates a copy of the serialization options instance.
With(Action<MdSerializationOptions>) Creates a copy of the serialization options instance and applies the specified update action.

Nested Types

Name Description
MdSerializationOptions.Presets

Documentation generated by MdDocs