MarkdownDocument
OfficeIMO.Markdown
Root document container for Markdown blocks and syntax helpers. Use MarkdownDocument.Add to append and retain a typed block.
Inheritance
- MarkdownObject
- MarkdownDocument
Usage
Explore 135 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 118
- Property AbbreviationInline.Document
- Property BoldInline.Document
- Property BoldItalicInline.Document
- Property BoldItalicSequenceInline.Document
- Property BoldSequenceInline.Document
- Property CalloutBlock.Document
- Property CodeBlock.Document
- Property CodeSpanInline.Document
- Property CustomContainerBlock.Document
- Property DefinitionListBlock.Document
- Property DefinitionListDefinition.Document
- Property DefinitionListEntry.Document
- Property DefinitionListGroup.Document
- Property DefinitionListTerm.Document
- Property DetailsBlock.Document
- Property FootnoteDefinitionBlock.Document
- Property FootnoteRefInline.Document
- Property FrontMatterBlock.Document
- Property HardBreakInline.Document
- Property HeadingBlock.Document
- Property HighlightInline.Document
- Property HighlightSequenceInline.Document
- Property HorizontalRuleBlock.Document
- Property HtmlCommentBlock.Document
- Property HtmlRawBlock.Document
- Property HtmlRawInline.Document
- Property HtmlTagSequenceInline.Document
- Property ImageBlock.Document
- Property ImageInline.Document
- Property ImageLinkInline.Document
- Method IMarkdownDocumentTransform.Transform
- Property InlineSequence.Document
- Property InsertedInline.Document
- Property InsertedSequenceInline.Document
- Property ItalicInline.Document
- Property ItalicSequenceInline.Document
- Property LinkInline.Document
- Property ListItem.Document
- Property MarkdownBlock.Document
- Property MarkdownBlockParserContext.Document
- Property MarkdownBodyRenderContext.Document
- Method MarkdownChangelogScaffold.Changelog
- Method MarkdownColonListBoundaryTransform.Transform
- Method MarkdownCompactHeadingBoundaryTransform.Transform
- Method MarkdownCompactStrongLabelListBoundaryTransform.Transform
- Method MarkdownContributingScaffold.Contributing
- Method MarkdownDocument.Callout
- Method MarkdownDocument.Caption
- Method MarkdownDocument.Code
- Method MarkdownDocument.Create
- Method MarkdownDocument.Details
- Method MarkdownDocument.Dl
- Method MarkdownDocument.FrontMatter
- Method MarkdownDocument.FrontMatter``1
- Method MarkdownDocument.H1
- Method MarkdownDocument.H2
- Method MarkdownDocument.H3
- Method MarkdownDocument.H4
- Method MarkdownDocument.H5
- Method MarkdownDocument.H6
- Method MarkdownDocument.Hr
- Method MarkdownDocument.Image
- Method MarkdownDocument.Load
- Method MarkdownDocument.LoadAsync
- Method MarkdownDocument.Ol
- Method MarkdownDocument.Ol``1
- Method MarkdownDocument.P
- Method MarkdownDocument.Parse
- Method MarkdownDocument.Quote
- Method MarkdownDocument.Rewrite
- Method MarkdownDocument.Table
- Method MarkdownDocument.TableAuto
- Method MarkdownDocument.Toc
- Method MarkdownDocument.TocAtTop
- Method MarkdownDocument.TocForPreviousHeading
- Method MarkdownDocument.TocForSection
- Method MarkdownDocument.TocHere
- Method MarkdownDocument.Ul
- Method MarkdownDocument.Ul``1
- Property MarkdownDocument.Document
- Method MarkdownHeadingListBoundaryTransform.Transform
- Property MarkdownInline.Document
- Method MarkdownInlineNormalizationTransform.Transform
- Method MarkdownIntelligenceXCachedToolEvidenceMarkerTransform.Transform
- Method MarkdownIntelligenceXLegacyToolHeadingTransform.Transform
- Method MarkdownJsonVisualCodeBlockTransform.Transform
- Method MarkdownListParagraphStrongArtifactTransform.Transform
- Property MarkdownNativeDocument.Document
- Property MarkdownObject.Document
- Property MarkdownParseInfo.Document
- Method MarkdownRegisteredFencedBlockTransform.Transform
- Method MarkdownRewriter.Rewrite
- Method MarkdownScaffold.Readme
- Method MarkdownSimpleDefinitionListParagraphTransform.Transform
- Method MarkdownStandaloneHashHeadingSeparatorTransform.Transform
- Property MarkdownTextRun.Document
- Method MarkdownTranscriptPreparation.PrepareIntelligenceXTranscriptDocument
- Method MarkdownTranscriptPreparation.PrepareIntelligenceXTranscriptDocumentForDocx
- Property MarkdownWriteContext.Document
- Property OrderedListBlock.Document
- Property ParagraphBlock.Document
- Property QuoteBlock.Document
- Property SemanticFencedBlock.Document
- Property SoftBreakInline.Document
- Property StrikethroughInline.Document
- Property StrikethroughSequenceInline.Document
- Property SubscriptInline.Document
- Property SubscriptSequenceInline.Document
- Property SummaryBlock.Document
- Property SuperscriptInline.Document
- Property SuperscriptSequenceInline.Document
- Property TableBlock.Document
- Property TableCell.Document
- Property TableRow.Document
- Property TocBlock.Document
- Property TocMarkerBlock.Document
- Property UnderlineInline.Document
- Property UnorderedListBlock.Document
Accepted by parameters 17
- Method IMarkdownBlockParser.TryParse
- Method IMarkdownDocumentTransform.Transform
- Method MarkdownColonListBoundaryTransform.Transform
- Method MarkdownCompactHeadingBoundaryTransform.Transform
- Method MarkdownCompactStrongLabelListBoundaryTransform.Transform
- Method MarkdownDocument.Callout
- Method MarkdownDocument.Details
- Method MarkdownHeadingListBoundaryTransform.Transform
- Method MarkdownInlineNormalizationTransform.Transform
- Method MarkdownIntelligenceXCachedToolEvidenceMarkerTransform.Transform
- Method MarkdownIntelligenceXLegacyToolHeadingTransform.Transform
- Method MarkdownJsonVisualCodeBlockTransform.Transform
- Method MarkdownListParagraphStrongArtifactTransform.Transform
- Method MarkdownRegisteredFencedBlockTransform.Transform
- Method MarkdownRewriter.Rewrite
- Method MarkdownSimpleDefinitionListParagraphTransform.Transform
- Method MarkdownStandaloneHashHeadingSeparatorTransform.Transform
Methods
public DefinitionListBlock AddDefinitionList(Action<MarkdownDefinitionListBuilder> build) #Appends a term/definition list composed with MarkdownDefinitionListBuilder and returns it.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownDefinitionListBuilder>
Returns
DefinitionListBlockpublic HeadingBlock AddHeading(string text, int level = 1) #Appends an ATX heading and returns it.
Parameters
- text string
- Heading text.
- level int = 1
- Heading level from 1 to 6.
Returns
HeadingBlockpublic ImageBlock AddImage(string path, string? altText = null, string? title = null, OfficeLength? width = null, OfficeLength? height = null) #Appends an image and returns it.
Parameters
- path string
- Image path or URL.
- altText string? = null
- Alternative text.
- title string? = null
- Optional image title.
- width OfficeIMO.OfficeLength? = null
- Optional display width.
- height OfficeIMO.OfficeLength? = null
- Optional display height.
Returns
ImageBlockpublic UnorderedListBlock AddList(Action<MarkdownUnorderedListBuilder> build) #Appends a bulleted list composed with MarkdownUnorderedListBuilder and returns it.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownUnorderedListBuilder>
Returns
UnorderedListBlockpublic UnorderedListBlock AddList<T>(IEnumerable<T?> items) #Appends a bulleted list with one item per value, formatted with ToString().
Type Parameters
- T
Parameters
- items System.Collections.Generic.IEnumerable<T?>
Returns
UnorderedListBlockpublic OrderedListBlock AddOrderedList(Action<MarkdownOrderedListBuilder> build) #Appends a numbered list composed with MarkdownOrderedListBuilder and returns it.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownOrderedListBuilder>
Returns
OrderedListBlockpublic OrderedListBlock AddOrderedList<T>(IEnumerable<T?> items, int start = 1) #Appends a numbered list with one item per value, formatted with ToString().
Type Parameters
- T
Parameters
- items System.Collections.Generic.IEnumerable<T?>
- Item values.
- start int = 1
- First item number.
Returns
OrderedListBlockpublic ParagraphBlock AddParagraph(string text) #Appends a paragraph containing plain text and returns it.
Parameters
- text string
Returns
ParagraphBlockpublic ParagraphBlock AddParagraph(Action<MarkdownParagraphBuilder> build) #Appends a paragraph composed with MarkdownParagraphBuilder and returns it.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownParagraphBuilder>
Returns
ParagraphBlockpublic IReadOnlyList<IMarkdownBlock> AddRange(IEnumerable<IMarkdownBlock> blocks) #Adds blocks in source order and binds the resulting object tree once.
Parameters
- blocks System.Collections.Generic.IEnumerable<OfficeIMO.Markdown.IMarkdownBlock>
- Blocks to append. Enumeration and null validation finish before the document changes.
public TableBlock AddTable(Action<MarkdownTableBuilder> build) #Appends a table composed with MarkdownTableBuilder and returns it.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownTableBuilder>
Returns
TableBlockpublic TableBlock AddTable(object? data, OfficeTableOptions? options = null) #Adds a table from runtime data, including scalar sequences and property/value objects.
Parameters
- data object?
- options OfficeIMO.OfficeTableOptions? = null
Returns
TableBlockpublic TableBlock AddTable<T>(IEnumerable<T?> rows, OfficeTableOptions? options = null) #Adds a table from declared properties, fields, or string-keyed dictionary rows in a single pass.
Type Parameters
- T
Parameters
- rows System.Collections.Generic.IEnumerable<T?>
- options OfficeIMO.OfficeTableOptions? = null
Returns
TableBlockpublic TableBlock AddTable<T>(IEnumerable<T?> rows, params ValueTuple<string, Func<T?, object?>>[] columns) #Adds a table using explicit selectors, with no runtime member discovery.
Type Parameters
- T
Parameters
- rows System.Collections.Generic.IEnumerable<T?>
- columns System.ValueTuple<string, System.Func<T?, object?>>[]
Returns
TableBlockpublic T Add<T>(T block) #Adds a block instance and returns that same typed block.
Type Parameters
- T
- The block type.
Parameters
- block T
- Block to append to the document.
Returns
T The attached block.public MarkdownDocument Callout(string kind, string title, string body) #Adds a callout/admonition block (Docs-style).
Parameters
- kind string
- title string
- body string
Returns
MarkdownDocumentpublic MarkdownDocument Callout(string kind, string title, Action<MarkdownDocument> buildBody) #Adds a callout/admonition block with structured markdown body content.
Parameters
- kind string
- title string
- buildBody System.Action<OfficeIMO.Markdown.MarkdownDocument>
Returns
MarkdownDocumentpublic MarkdownDocument Caption(string caption) #Sets a caption for the last captionable block (image/code), or appends a paragraph.
Parameters
- caption string
Returns
MarkdownDocumentpublic MarkdownDocument Code(string language, string content) #Adds a fenced code block.
Parameters
- language string
- content string
Returns
MarkdownDocumentpublic static MarkdownDocument Create(MarkdownCreateOptions? options = null) #Creates a new, empty Markdown document.
Parameters
- options OfficeIMO.Markdown.MarkdownCreateOptions? = null
Returns
MarkdownDocumentpublic static MarkdownDocument Create(string filePath, MarkdownCreateOptions? options = null) #Creates a Markdown document associated with a path, without writing the file.
Parameters
- filePath string
- options OfficeIMO.Markdown.MarkdownCreateOptions? = null
Returns
MarkdownDocumentpublic IEnumerable<HeadingBlock> DescendantHeadings() #Enumerates all headings in document order, including nested headings.
Returns
IEnumerable<HeadingBlock>public IEnumerable<ListItem> DescendantListItems() #Enumerates all list items in document order, including nested items.
Returns
IEnumerable<ListItem>public IEnumerable<IMarkdownBlock> DescendantsAndSelf() #Enumerates all document blocks depth-first, including front matter when present.
Returns
IEnumerable<IMarkdownBlock>public IEnumerable<TBlock> DescendantsOfType<TBlock>() #Enumerates all document blocks of the requested type depth-first.
Type Parameters
- TBlock
Returns
IEnumerable<TBlock>public IEnumerable<TableCell> DescendantTableCells() #Enumerates all table cells in document order, including header cells and nested tables.
Returns
IEnumerable<TableCell>public IEnumerable<TableRow> DescendantTableRows() #Enumerates all table rows in document order, including header rows and nested tables.
Returns
IEnumerable<TableRow>public IEnumerable<TableBlock> DescendantTables() #Enumerates all tables in document order, including nested tables.
Returns
IEnumerable<TableBlock>public MarkdownDocument Details(string summary, Action<MarkdownDocument> buildBody, bool open = false) #Adds a collapsible details block.
Parameters
- summary string
- buildBody System.Action<OfficeIMO.Markdown.MarkdownDocument>
- open bool = false
Returns
MarkdownDocumentpublic void Dispose() #Completes this in-memory document's lifetime without closing caller-owned streams.
public MarkdownDocument Dl(Action<MarkdownDefinitionListBuilder> build) #Adds a definition list. Shortcut for MarkdownDocument.AddDefinitionList.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownDefinitionListBuilder>
Returns
MarkdownDocumentpublic TBlock? FindFirstDescendantOfType<TBlock>() #Finds the first document block of the requested type depth-first.
Type Parameters
- TBlock
Returns
TBlock?public TBlock? FindFirstTopLevelBlockOfType<TBlock>() #Finds the first top-level document block of the requested type.
Type Parameters
- TBlock
Returns
TBlock?public Entry? FindFrontMatterEntry(string key, StringComparison comparison = OrdinalIgnoreCase) #Finds a front matter entry by key when the document header is present.
Parameters
- key string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
Entry?public HeadingInfo? FindHeading(string text, StringComparison comparison = OrdinalIgnoreCase) #Finds the first heading whose plain text matches the provided heading text.
Parameters
- text string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
HeadingInfo?public HeadingInfo? FindHeadingByAnchor(string anchor) #Finds the heading with the specified resolved anchor, if present.
Parameters
- anchor string
Returns
HeadingInfo?public IReadOnlyList<HeadingInfo> FindHeadings(string text, StringComparison comparison = OrdinalIgnoreCase) #Finds headings whose plain text matches the provided heading text.
Parameters
- text string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
IReadOnlyList<HeadingInfo>public MarkdownDocument FrontMatter(object data) #Sets YAML front matter from an anonymous object or dictionary.
Parameters
- data object
Returns
MarkdownDocumentpublic MarkdownDocument FrontMatter<T>(T? data) #Sets YAML front matter from a type known at publish time.
Type Parameters
- T
Parameters
- data T?
Returns
MarkdownDocumentpublic string GetHeadingAnchor(HeadingBlock heading) #Gets the resolved anchor id for a heading within this document.
Parameters
- heading OfficeIMO.Markdown.HeadingBlock
Returns
stringpublic IReadOnlyList<HeadingInfo> GetHeadingInfos() #Returns resolved heading metadata in document order.
Returns
IReadOnlyList<HeadingInfo>public MarkdownDocument H1(string text) #Adds a level 1 heading. Shortcut for MarkdownDocument.AddHeading.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument H2(string text) #Adds a level 2 heading. Shortcut for MarkdownDocument.AddHeading.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument H3(string text) #Adds a level 3 heading. Shortcut for MarkdownDocument.AddHeading.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument H4(string text) #Adds a level 4 heading. Shortcut for MarkdownDocument.AddHeading.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument H5(string text) #Adds a level 5 heading. Shortcut for MarkdownDocument.AddHeading.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument H6(string text) #Adds a level 6 heading. Shortcut for MarkdownDocument.AddHeading.
Parameters
- text string
Returns
MarkdownDocumentpublic bool HasDescendantOfType<TBlock>() #Checks whether the document has any block of the requested type depth-first.
Type Parameters
- TBlock
Returns
boolpublic bool HasFrontMatterEntry(string key, StringComparison comparison = OrdinalIgnoreCase) #Checks whether the document header contains an entry with the specified key.
Parameters
- key string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
boolpublic bool HasHeading(string text, StringComparison comparison = OrdinalIgnoreCase) #Checks whether a heading whose plain text matches the provided heading text is present.
Parameters
- text string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
boolpublic bool HasHeadingAnchor(string anchor) #Checks whether a heading with the specified resolved anchor is present.
Parameters
- anchor string
Returns
boolpublic bool HasTopLevelBlockOfType<TBlock>() #Checks whether the document has a top-level block of the requested type.
Type Parameters
- TBlock
Returns
boolpublic MarkdownDocument Image(string path, string? altText = null, string? title = null, OfficeLength? width = null, OfficeLength? height = null) #Adds an image. Shortcut for MarkdownDocument.AddImage.
Parameters
- path string
- altText string? = null
- title string? = null
- width OfficeIMO.OfficeLength? = null
- height OfficeIMO.OfficeLength? = null
Returns
MarkdownDocumentpublic static MarkdownDocument Load(string path, MarkdownLoadOptions? options = null) #Loads Markdown from a path and associates it for subsequent saves.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownLoadOptions? = null
Returns
MarkdownDocumentpublic static MarkdownDocument Load(Stream stream, MarkdownLoadOptions? options = null) #Loads Markdown from a caller-owned stream, preserving seekable stream position.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownLoadOptions? = null
Returns
MarkdownDocumentpublic static MarkdownDocument Load(string path, MarkdownLoadOptions? options, out OfficeConversionReport report) #Loads a Markdown file and returns its completed native read report.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownLoadOptions?
- report OfficeIMO.OfficeConversionReport
Returns
MarkdownDocumentpublic static MarkdownDocument Load(Stream stream, MarkdownLoadOptions? options, out OfficeConversionReport report) #Loads a caller-owned Markdown stream and returns its completed native read report.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownLoadOptions?
- report OfficeIMO.OfficeConversionReport
Returns
MarkdownDocumentpublic static async Task<MarkdownDocument> LoadAsync(string path, MarkdownLoadOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously loads a Markdown file and associates its path.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<MarkdownDocument>public static async Task<MarkdownDocument> LoadAsync(Stream stream, MarkdownLoadOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously loads Markdown from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<MarkdownDocument>public MarkdownDocument Ol(Action<MarkdownOrderedListBuilder> build) #Adds a numbered list. Shortcut for MarkdownDocument.AddOrderedList.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownOrderedListBuilder>
Returns
MarkdownDocumentpublic MarkdownDocument Ol<T>(IEnumerable<T?> items, int start = 1) #Adds a numbered list from item values. Shortcut for MarkdownDocument.AddOrderedList.
Type Parameters
- T
Parameters
- items System.Collections.Generic.IEnumerable<T?>
- start int = 1
Returns
MarkdownDocumentpublic MarkdownDocument P(string text) #Adds a paragraph with plain text. Shortcut for MarkdownDocument.AddParagraph.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument P(Action<MarkdownParagraphBuilder> build) #Adds a paragraph composed with the paragraph builder. Shortcut for MarkdownDocument.AddParagraph.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownParagraphBuilder>
Returns
MarkdownDocumentpublic static MarkdownDocument Parse(string markdown, MarkdownLoadOptions? options = null) #Parses Markdown text into the document model.
Parameters
- markdown string
- options OfficeIMO.Markdown.MarkdownLoadOptions? = null
Returns
MarkdownDocumentpublic static MarkdownDocument Parse(string markdown, MarkdownLoadOptions? options, out OfficeConversionReport report) #Parses Markdown text and reports the completed native read.
Parameters
- markdown string
- options OfficeIMO.Markdown.MarkdownLoadOptions?
- report OfficeIMO.OfficeConversionReport
Returns
MarkdownDocumentpublic MarkdownDocument Quote(string text) #Adds a simple block quote with a single line of text.
Parameters
- text string
Returns
MarkdownDocumentpublic MarkdownDocument Quote(Action<MarkdownQuoteBuilder> build) #Adds a block quote composed via MarkdownQuoteBuilder.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownQuoteBuilder>
Returns
MarkdownDocumentpublic MarkdownDocument Rewrite(MarkdownRewriter rewriter) #Rewrites the document using the provided rewriter.
Parameters
- rewriter OfficeIMO.Markdown.MarkdownRewriter
Returns
MarkdownDocumentpublic void Save(MarkdownSaveOptions options) #Saves to the associated path with explicit writer options.
Parameters
- options OfficeIMO.Markdown.MarkdownSaveOptions
public void Save(string path, MarkdownSaveOptions? options = null) #Atomically saves the native document and associates its path.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownSaveOptions? = null
public void Save(Stream stream, MarkdownSaveOptions? options = null) #Writes native Markdown to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownSaveOptions? = null
public OfficeConversionReport SaveAsHtml(string path, MarkdownHtmlExportOptions? options = null) #Writes HTML to a file, including an external CSS sidecar when requested.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
Returns
OfficeConversionReportpublic OfficeConversionReport SaveAsHtml(Stream stream, MarkdownHtmlExportOptions? options = null) #Writes HTML to a caller-owned stream. External CSS requires a file destination.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
Returns
OfficeConversionReportpublic async Task<OfficeConversionReport> SaveAsHtmlAsync(string path, MarkdownHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes HTML to a file, including an external CSS sidecar when requested.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public async Task<OfficeConversionReport> SaveAsHtmlAsync(Stream stream, MarkdownHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes HTML to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public Task SaveAsync(CancellationToken cancellationToken = default) #Asynchronously saves to the associated path.
Parameters
- cancellationToken System.Threading.CancellationToken = default
Returns
Taskpublic async Task SaveAsync(string path, MarkdownSaveOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously saves the native document and associates its path.
Parameters
- path string
- options OfficeIMO.Markdown.MarkdownSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Taskpublic Task SaveAsync(Stream stream, MarkdownSaveOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes native Markdown to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Markdown.MarkdownSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Taskpublic MarkdownDocument Table(Action<MarkdownTableBuilder> build) #Adds a table. Shortcut for MarkdownDocument.AddTable.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownTableBuilder>
Returns
MarkdownDocumentpublic MarkdownDocument TableAuto(Action<MarkdownTableBuilder> build, bool alignNumeric = true, bool alignDates = true) #Adds a table with numeric/date alignment heuristics. Shortcut for MarkdownDocument.AddTable followed by the builder's AlignDatesCenter and AlignNumericRight.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownTableBuilder>
- alignNumeric bool = true
- alignDates bool = true
Returns
MarkdownDocumentpublic byte[] ToBytes(MarkdownSaveOptions? options = null, CancellationToken cancellationToken = default) #Encodes the native document with the selected writer and encoding.
Parameters
- options OfficeIMO.Markdown.MarkdownSaveOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public MarkdownDocument Toc(Action<MarkdownTocOptions>? configure = null, bool placeAtTop = false) #Generates a MarkdownTable of Contents from headings already present in the document and inserts it.
Parameters
- configure System.Action<OfficeIMO.Markdown.MarkdownTocOptions>? = null
- Optional TOC options.
- placeAtTop bool = false
- When true, inserts TOC as the first block; otherwise appended.
Returns
MarkdownDocumentpublic MarkdownDocument TocAtTop(string title = "Contents", int min = 1, int max = 3, bool ordered = false, int titleLevel = 2) #Convenience helper to insert a MarkdownTable of Contents at the top with common parameters.
Parameters
- title string = "Contents"
- min int = 1
- max int = 3
- ordered bool = false
- titleLevel int = 2
Returns
MarkdownDocumentpublic MarkdownDocument TocForPreviousHeading(string? title = "Contents", int min = 2, int max = 6, bool ordered = false, int titleLevel = 3) #Inserts a section TOC for the nearest preceding heading. Useful to place a small TOC under a section.
Parameters
- title string? = "Contents"
- min int = 2
- max int = 6
- ordered bool = false
- titleLevel int = 3
Returns
MarkdownDocumentpublic MarkdownDocument TocForSection(string headingTitle, string? title = "Contents", int min = 2, int max = 6, bool ordered = false, int titleLevel = 3) #Inserts a section TOC scoped to the named heading.
Parameters
- headingTitle string
- title string? = "Contents"
- min int = 2
- max int = 6
- ordered bool = false
- titleLevel int = 3
Returns
MarkdownDocumentpublic MarkdownDocument TocHere(Action<MarkdownTocOptions>? configure = null) #Inserts a TOC placeholder at the current position without a title heading by default.
Parameters
- configure System.Action<OfficeIMO.Markdown.MarkdownTocOptions>? = null
Returns
MarkdownDocumentpublic string ToHtml(MarkdownHtmlExportOptions? options = null) #Converts Markdown to HTML text using the requested fragment or document options.
Parameters
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
Returns
stringpublic string ToHtml(MarkdownHtmlExportOptions? options, out OfficeConversionReport report) #Converts Markdown to HTML text and returns its fidelity report.
Parameters
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
Returns
stringpublic async Task<OfficeConversionResult<string>> ToHtmlAsync(MarkdownHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously converts Markdown to HTML text with its fidelity report.
Parameters
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<string>>public MarkdownHtmlParts ToHtmlParts(MarkdownHtmlExportOptions? options = null) #Returns rendered parts for advanced embedding (Head, Body, Css, Scripts).
Parameters
- options OfficeIMO.Markdown.MarkdownHtmlExportOptions? = null
Returns
MarkdownHtmlPartspublic string ToMarkdown(MarkdownSaveOptions? options) #Renders Markdown using optional writer extensions or portability fallbacks.
Parameters
- options OfficeIMO.Markdown.MarkdownSaveOptions?
Returns
stringpublic string ToMarkdown(MarkdownSaveOptions? options, CancellationToken cancellationToken) #Renders Markdown with cooperative cancellation between blocks, inline nodes and writer extensions.
Parameters
- options OfficeIMO.Markdown.MarkdownSaveOptions?
- cancellationToken System.Threading.CancellationToken
Returns
stringpublic IEnumerable<TBlock> TopLevelBlocksOfType<TBlock>() #Enumerates top-level document blocks of the requested type.
Type Parameters
- TBlock
Returns
IEnumerable<TBlock>public bool TryGetFrontMatterValue<T>(string key, out T? value) #Gets a typed front matter value by key when the document header is present.
Type Parameters
- T
Parameters
- key string
- value T?
Returns
boolpublic MarkdownDocument Ul(Action<MarkdownUnorderedListBuilder> build) #Adds a bulleted list. Shortcut for MarkdownDocument.AddList.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownUnorderedListBuilder>
Returns
MarkdownDocumentpublic MarkdownDocument Ul<T>(IEnumerable<T?> items) #Adds a bulleted list from item values. Shortcut for MarkdownDocument.AddList.
Type Parameters
- T
Parameters
- items System.Collections.Generic.IEnumerable<T?>
Returns
MarkdownDocumentInherited Methods
public void Accept(MarkdownVisitor visitor) #Parameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #Returns
IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #Returns
IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #Type Parameters
- TObject
Returns
IEnumerable<TObject>public IEnumerable<MarkdownObject> Descendants() #Returns
IEnumerable<MarkdownObject>Properties
public string? FilePath { get; } #Gets the associated path, or null for an in-memory document.
public MarkdownParseInfo? ParseInfo { get; } #Gets the source syntax and transform snapshot, when the document was parsed.
public IReadOnlyList<IMarkdownBlock> Blocks { get; } #All blocks added to the document (excluding front matter).
public FrontMatterBlock? DocumentHeader { get; } #Document-level front matter/header block when present.
public IReadOnlyList<Entry> FrontMatterEntries { get; } #Structured document front matter entries when present.
public IReadOnlyList<IMarkdownBlock> TopLevelBlocks { get; } #All top-level document blocks in order, including front matter when present.
public bool HasDocumentHeader { get; } #Whether the document has front matter.
Inherited Properties
public MarkdownSourceSpan? SourceSpan { get; internal set; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #