OfficeIMO

API Reference

Class

MarkdownReader

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers static

Block parsing helpers for MarkdownReader.

Inheritance

  • Object
  • MarkdownReader

Methods

LooksLikeTableRow(System.String arg1) #

Determines whether a line is likely to be part of a markdown table. The logic follows CommonMark's relaxed table rules: when both outer pipes are present a single column is permitted, otherwise at least two pipe-separated cells are required so that plain paragraphs containing a single | are not mis-classified as tables.

Parameters

arg1 System.String required
public static MarkdownDoc Parse(String markdown, MarkdownReaderOptions options = null) #
Returns: MarkdownDoc

Parses Markdown text into a MarkdownDoc with typed blocks and basic inlines.

Parameters

markdown System.String requiredposition: 0
options OfficeIMO.Markdown.MarkdownReaderOptions = null optionalposition: 1
public static MarkdownDoc ParseFile(String path, MarkdownReaderOptions options = null) #
Returns: MarkdownDoc

Parses a Markdown file path into a MarkdownDoc.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Markdown.MarkdownReaderOptions = null optionalposition: 1
public static InlineSequence ParseInlineText(String text, MarkdownReaderOptions options = null) #
Returns: InlineSequence

Parses a single line of Markdown inline content into a typed InlineSequence. This helper is exposed to allow other components (e.g., Word converter) to interpret inline markup in contexts like table cells where we currently store raw strings.

Parameters

text System.String requiredposition: 0
Inline Markdown text.
options OfficeIMO.Markdown.MarkdownReaderOptions = null optionalposition: 1
Reader options controlling inline interpretation.

Returns

Parsed sequence of inline nodes.

public static MarkdownParseResult ParseWithSyntaxTree(String markdown, MarkdownReaderOptions options = null) #
Returns: MarkdownParseResult

Parses Markdown text into both the object model and a lightweight syntax tree with source spans.

Parameters

markdown System.String requiredposition: 0
options OfficeIMO.Markdown.MarkdownReaderOptions = null optionalposition: 1
public static MarkdownParseResult ParseWithSyntaxTreeAndDiagnostics(String markdown, MarkdownReaderOptions options = null) #
Returns: MarkdownParseResult

Parses Markdown text into the object model, original syntax tree, and document-transform diagnostics.

Parameters

markdown System.String requiredposition: 0
options OfficeIMO.Markdown.MarkdownReaderOptions = null optionalposition: 1