Meziantou.FrameworkAdfToMarkdownOptions Class
Options that control how an ADF document is converted to Markdown.
public sealed class AdfToMarkdownOptionsConstructors
| Name | Description |
|---|---|
| AdfToMarkdownOptions() |
AdfToMarkdownOptions()
AdfToMarkdownOptions.cspublic AdfToMarkdownOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| CodeBlockFenceCharacter | Gets or sets the fence character used for fenced code blocks. |
| CodeBlockStyle | Gets or sets the style used for code blocks. |
| DateFormat | Gets or sets the format used for dates. The value is a standard or custom DateTimeOffset format string, applied with the invariant culture. |
| DecisionListStyle | Gets or sets how decision lists are converted. |
| EmojiRendering | Gets or sets how emoji are converted. |
| EmphasisMarker | Gets or sets the marker used for emphasis. |
| ExpandStyle | Gets or sets how collapsible sections are converted. |
| HeadingStyle | Gets or sets the heading style to use in Markdown output. |
| LineBreakStyle | Gets or sets the style used for explicit line breaks. |
| MediaRendering | Gets or sets how media items are converted. |
| MediaUrlResolver | Gets or sets a callback that returns the URL of a media item, or null when it cannot be resolved. |
| MentionFormat | Gets or sets the format used for mentions. The {text} placeholder is replaced with the display name of the mentioned user, and {id} with their account identifier. |
| MentionResolver | Gets or sets a callback that returns the display name of a mentioned user, or null to use the text stored in the document. |
| PanelStyle | Gets or sets how panels are converted. |
| StatusFormat | Gets or sets the format used for status lozenges. The {text} placeholder is replaced with the text of the lozenge, and {color} with its color. |
| TableStyle | Gets or sets how tables are converted. |
| TaskListStyle | Gets or sets how task lists are converted. |
| ThematicBreak | Gets or sets the thematic break text to emit for horizontal rules. |
| UnknownNodeHandling | Gets or sets how nodes whose type is not part of the supported schema are converted. |
| UnorderedListMarker | Gets or sets the marker used for unordered lists. |
CodeBlockFenceCharacter
AdfToMarkdownOptions.csCodeBlockStyle
AdfToMarkdownOptions.csGets or sets the style used for code blocks.
public AdfCodeBlockStyle CodeBlockStyle { get; set; }Property value
DateFormat
AdfToMarkdownOptions.csGets or sets the format used for dates. The value is a standard or custom DateTimeOffset format string, applied with the invariant culture.
public string DateFormat { get; set; }Property value
DecisionListStyle
AdfToMarkdownOptions.csGets or sets how decision lists are converted.
public AdfDecisionListStyle DecisionListStyle { get; set; }Property value
EmojiRendering
AdfToMarkdownOptions.csGets or sets how emoji are converted.
public AdfEmojiRendering EmojiRendering { get; set; }Property value
EmphasisMarker
AdfToMarkdownOptions.csGets or sets the marker used for emphasis.
public AdfEmphasisMarker EmphasisMarker { get; set; }Property value
ExpandStyle
AdfToMarkdownOptions.csGets or sets how collapsible sections are converted.
public AdfExpandStyle ExpandStyle { get; set; }Property value
HeadingStyle
AdfToMarkdownOptions.csGets or sets the heading style to use in Markdown output.
public AdfHeadingStyle HeadingStyle { get; set; }Property value
LineBreakStyle
AdfToMarkdownOptions.csGets or sets the style used for explicit line breaks.
public AdfLineBreakStyle LineBreakStyle { get; set; }Property value
MediaRendering
AdfToMarkdownOptions.csGets or sets how media items are converted.
public AdfMediaRendering MediaRendering { get; set; }Property value
MediaUrlResolver
AdfToMarkdownOptions.csGets or sets a callback that returns the URL of a media item, or null when it cannot be resolved.
Property value
Remarks
Only media items of type AdfMediaType.External carry a URL in the document. Items stored by Atlassian only carry an identifier and a collection, and resolving them requires an authenticated call to the media API.
MentionFormat
AdfToMarkdownOptions.csMentionResolver
AdfToMarkdownOptions.csGets or sets a callback that returns the display name of a mentioned user, or null to use the text stored in the document.
public Func<AdfMention, string?>? MentionResolver { get; set; }Property value
Remarks
Documents returned by the APIs often omit the display name of a mention.
PanelStyle
AdfToMarkdownOptions.csStatusFormat
AdfToMarkdownOptions.csTableStyle
AdfToMarkdownOptions.csTaskListStyle
AdfToMarkdownOptions.csGets or sets how task lists are converted.
public AdfTaskListStyle TaskListStyle { get; set; }Property value
ThematicBreak
AdfToMarkdownOptions.csUnknownNodeHandling
AdfToMarkdownOptions.csGets or sets how nodes whose type is not part of the supported schema are converted.
public AdfUnknownNodeHandling UnknownNodeHandling { get; set; }