API Reference
MarkdownWriteOptions
Options controlling markdown serialization from the typed document model.
Inheritance
- Object
- MarkdownWriteOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property MarkdownInlineMarkdownRenderContext.Options
- Property MarkdownWriteContext.Options
- Method MarkdownWriteOptions.Clone
- Method MarkdownWriteOptions.CreateCommonMarkProfile
- Method MarkdownWriteOptions.CreateGitHubFlavoredMarkdownProfile
- Method MarkdownWriteOptions.CreateHtmlImageProfile
- Method MarkdownWriteOptions.CreateOfficeIMOProfile
- Method MarkdownWriteOptions.CreatePortableProfile
- Method MarkdownWriteOptions.CreateProfile
Accepted by parameters
- Method MarkdownBlockMarkdownRenderer.BeginInvoke
- Method MarkdownBlockMarkdownRenderer.Invoke
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkAttributedBlockMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkCustomContainerMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkDefinitionListMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkDetailsMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkFootnoteDefinitionMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkParagraphLineStartMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkTableMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddCommonMarkTaskListMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddGitHubAttributedBlockMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddGitHubCustomContainerMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddGitHubDefinitionListMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddGitHubParagraphLineStartMarkdownFallback
- Method MarkdownBlockRenderBuiltInExtensions.AddPortableCalloutMarkdownFallback
- Method MarkdownDoc.Save
- Method MarkdownDoc.Save
- Method MarkdownDoc.SaveAsync
- Method MarkdownDoc.SaveAsync
- Method MarkdownDoc.ToBytes
- Method MarkdownDoc.ToMarkdown
- Method MarkdownDoc.ToStream
- Method MarkdownInlineMarkdownRenderer.BeginInvoke
- Method MarkdownInlineMarkdownRenderer.Invoke
- Method MarkdownInlineRenderBuiltInExtensions.AddCommonMarkAttributedInlineMarkdownFallback
- Method MarkdownInlineRenderBuiltInExtensions.AddCommonMarkGfmInlineMarkdownFallbacks
- Method MarkdownInlineRenderBuiltInExtensions.AddGitHubAttributedInlineMarkdownFallback
- Method MarkdownInlineRenderBuiltInExtensions.AddGitHubOfficeInlineMarkdownFallbacks
Constructors
public MarkdownWriteOptions() #Methods
public MarkdownWriteOptions Clone() #MarkdownWriteOptionsCreates a shallow clone of the writer options while copying mutable collections.
public static MarkdownWriteOptions CreateCommonMarkProfile() #MarkdownWriteOptionsCreates a CommonMark-oriented writer profile. GitHub-only constructs such as pipe tables are emitted using portable raw HTML fallbacks when a plain CommonMark representation does not exist.
public static MarkdownWriteOptions CreateGitHubFlavoredMarkdownProfile() #MarkdownWriteOptionsCreates a GitHub Flavored Markdown-oriented writer profile for README and GitHub documentation output.
public static MarkdownWriteOptions CreateHtmlImageProfile() #MarkdownWriteOptionsCreates a markdown writer profile that emits raw HTML for image output.
public static MarkdownWriteOptions CreateOfficeIMOProfile() #MarkdownWriteOptionsCreates default OfficeIMO-flavored markdown writer options.
public static MarkdownWriteOptions CreatePortableProfile() #MarkdownWriteOptionsCreates a more portable markdown writer profile that degrades OfficeIMO-only blocks into broadly compatible markdown.
public static MarkdownWriteOptions CreateProfile(MarkdownOutputProfile profile) #MarkdownWriteOptionsCreates writer options for the requested output profile.
Parameters
- profile OfficeIMO.Markdown.MarkdownOutputProfile
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public MarkdownImageRenderingMode ImageRenderingMode { get; set; } #Controls how image blocks and image inlines are serialized back to markdown text.
public MarkdownFrontMatterRenderingMode FrontMatterRendering { get; set; } #Controls how YAML front matter is emitted by MarkdownWriteOptions).
public MarkdownAbbreviationDefinitionRenderingMode AbbreviationDefinitionRendering { get; set; } #Controls how parse-owned abbreviation definitions are emitted by MarkdownWriteOptions).
public String OutputLineEnding { get; set; } #Optional line ending to use in rendered Markdown. When unset, the platform default is used.
public Char UnorderedListMarker { get; set; } #Marker used when rendering unordered list items. CommonMark-compatible values are -, *, and +.
public List<MarkdownBlockMarkdownRenderExtension> BlockRenderExtensions { get; } #Optional markdown block render extensions. Later registrations win when block types overlap.
public List<MarkdownInlineMarkdownRenderExtension> InlineRenderExtensions { get; } #Optional markdown inline render extensions. Later registrations win when inline types overlap.
public List<MarkdownSyntaxBlockMarkdownRenderExtension> SyntaxBlockRenderExtensions { get; } #Optional markdown block render extensions that match parsed blocks by final syntax kind. Later registrations win when syntax kinds overlap. These extensions run before type-based block extensions.
public List<MarkdownSyntaxInlineMarkdownRenderExtension> SyntaxInlineRenderExtensions { get; } #Optional markdown inline render extensions that match parsed inlines by final syntax kind. Later registrations win when syntax kinds overlap. These extensions run before type-based inline extensions.