MarkdownFormattingOptions Class
Configures how MarkdownFormatter writes a document.
public sealed class MarkdownFormattingOptions : IEquatable<MarkdownFormattingOptions>- Implements
Constructors
| Name | Description |
|---|---|
| MarkdownFormattingOptions() |
MarkdownFormattingOptions()
MarkdownFormattingOptions.cspublic MarkdownFormattingOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| AlignTables | Gets a value indicating whether the cells of the tables are padded so that their pipes are aligned in a monospace editor, where a wide character, such as a CJK ideograph or an emoji, uses two columns, and a combining mark none. The default is true. The pipe tables whose delimiter row gives the widths of the columns, with MarkdownPipeTableOptions.InferColumnWidthsFromSeparator, and the tables without a delimiter row are kept. |
| BulletListMarker | Gets the marker of the items of the bullet lists: -, the default, * or +, or null to keep the marker of each list. |
| CodeFenceCharacter | Gets the character of the fences of the code blocks: `, the default, or ~. A code block whose info string has a backtick is fenced with ~. |
| Default | Gets the options used when none are given. |
| NewLine | Gets the line ending of the lines: "\n", "\r\n" or "\r", or null, the default, for the first line ending of the document, or "\n" when it has a single line. |
| RenumberOrderedLists | Gets a value indicating whether the items of an ordered list are numbered from the number of the first one, which is the only one that changes the HTML. The default is true. The letters and the roman numbers of MarkdownExtensions.ListExtras are kept. |
| ThematicBreakCharacter | Gets the character of the thematic breaks: -, the default, * or _. A thematic break that follows a block without a blank line is written with *, as --- would make a paragraph before it a heading, and a thematic break that starts a list item is written with _, as - --- is a thematic break. |
| UseAtxHeadings | Gets a value indicating whether the setext headings, which are underlined, are written as ATX headings, which start with #. The default is true. A setext heading of several lines stays a setext heading. |
| UseFencedCodeBlocks | Gets a value indicating whether the indented code blocks are written as fenced code blocks. The default is true. |
AlignTables
MarkdownFormattingOptions.csGets a value indicating whether the cells of the tables are padded so that their pipes are aligned in a monospace editor, where a wide character, such as a CJK ideograph or an emoji, uses two columns, and a combining mark none. The default is true. The pipe tables whose delimiter row gives the widths of the columns, with MarkdownPipeTableOptions.InferColumnWidthsFromSeparator, and the tables without a delimiter row are kept.
public bool AlignTables { get; init; }Property value
BulletListMarker
MarkdownFormattingOptions.csGets the marker of the items of the bullet lists: -, the default, * or +, or null to keep the marker of each list.
public char? BulletListMarker { get; init; }Property value
Remarks
Two lists that follow each other are one list when their markers are the same, and a list item whose text is made of dashes is a thematic break: such a list gets another marker.
CodeFenceCharacter
MarkdownFormattingOptions.csDefault
MarkdownFormattingOptions.csGets the options used when none are given.
public static MarkdownFormattingOptions Default { get; }Property value
NewLine
MarkdownFormattingOptions.csRenumberOrderedLists
MarkdownFormattingOptions.csGets a value indicating whether the items of an ordered list are numbered from the number of the first one, which is the only one that changes the HTML. The default is true. The letters and the roman numbers of MarkdownExtensions.ListExtras are kept.
public bool RenumberOrderedLists { get; init; }Property value
ThematicBreakCharacter
MarkdownFormattingOptions.csGets the character of the thematic breaks: -, the default, * or _. A thematic break that follows a block without a blank line is written with *, as --- would make a paragraph before it a heading, and a thematic break that starts a list item is written with _, as - --- is a thematic break.
public char ThematicBreakCharacter { get; init; }Property value
UseAtxHeadings
MarkdownFormattingOptions.csUseFencedCodeBlocks
MarkdownFormattingOptions.csMethods
| Name | Description |
|---|---|
| Equals(MarkdownFormattingOptions?) | |
| Equals(object?) | |
| GetHashCode() | |
| ToString() |
Equals overloads
Equals(MarkdownFormattingOptions?)
public bool Equals(MarkdownFormattingOptions? other)No documentation is available.
Equals(object?)
GetHashCode()
ToString()
Operators
| Name | Description |
|---|---|
| operator ==(MarkdownFormattingOptions?, MarkdownFormattingOptions?) | |
| operator !=(MarkdownFormattingOptions?, MarkdownFormattingOptions?) |
operator ==(MarkdownFormattingOptions?, MarkdownFormattingOptions?)
public static bool operator ==(MarkdownFormattingOptions? left, MarkdownFormattingOptions? right)No documentation is available.
operator !=(MarkdownFormattingOptions?, MarkdownFormattingOptions?)
public static bool operator !=(MarkdownFormattingOptions? left, MarkdownFormattingOptions? right)No documentation is available.