MarkdownReaderOptions

Creates a new OfficeIMO-flavored reader configuration with the built-in block syntax extensions registered.

Creates a CommonMark-style core profile. This disables OfficeIMO-only and GFM-style extensions such as front matter, task lists, tables, definition lists, TOC placeholders, and footnotes.

Creates a GitHub Flavored Markdown-style profile. This keeps CommonMark core behavior plus tables, task lists, and footnotes, while disabling OfficeIMO-only callouts and TOC placeholders.

Creates the explicit OfficeIMO profile. This mirrors the library defaults and keeps host-oriented extensions such as callouts, TOC placeholders, and footnotes enabled.

Creates a reader configuration for portable Markdown behavior across stricter hosts. Bare http(s)://..., www.*, and plain email tokens remain literal text, and OfficeIMO-specific extensions such as Docs-style callouts, TOC placeholders, and footnotes are disabled. Explicit Markdown links, angle-bracket autolinks, and plain unordered lists continue to work.

Creates a reader configuration for the requested dialect/profile.

Parameters

profile OfficeIMO.Markdown.MarkdownReaderOptions.MarkdownDialectProfile requiredposition: 0

Enable YAML front matter parsing at the very top of the file.

Enable recognition of Docs-style callouts ("> [!KIND] Title" blocks).

Enable ATX headings (#, ##, ...).

Enable fenced code blocks (```lang ... ```), including caption on the following _line_ if present.

Enable indented code blocks (lines indented by 4 spaces).

Enable images (standalone lines) with optional caption on the next _italic_ line.

When true, a line containing only markdown image syntax (optionally with a following caption line) is promoted into a typed ImageBlock instead of remaining a paragraph with inline image content. Default: true for OfficeIMO-oriented parsing.

Enable unordered lists and task lists.

Enable task list checkbox parsing inside unordered and ordered list items.

Enable ordered (numbered) lists.

When true, nested list levels are derived from continuation-indent rules instead of the library's more permissive legacy indentation heuristic. Enabled by stricter compatibility profiles.

Enable pipe tables with optional header + alignment row.

Enable definition lists (Term: Definition lines).

Enable placeholder TOC markers such as [TOC] and {:toc}.

Enable footnote references and footnote definition blocks.

When true, GitHub Flavored Markdown-style single-tilde strikethrough (~text~) is enabled. Default: false.

When true, isolated single-line Term: Definition patterns stay as narrative paragraphs. Consecutive definition-like lines still parse as a definition list.

Enable raw HTML blocks. When set to false, block-level HTML is preserved as plain text so that readers can postprocess or render it verbatim.

Enable paragraph parsing and basic inlines.

When true, auto-detects plain http(s)://... URLs in text and turns them into links. Default: true.

When true, auto-detects plain www.example.com URLs in text and turns them into links. Default: true.

Scheme prefix to use for AutolinkWwwUrls (for example https://). Default: https://.

When true, auto-detects plain emails in text (for example [email protected]) and turns them into mailto: links. Default: true.

When true, a trailing backslash at the end of a paragraph line is treated as a hard line break (like GitHub/CommonMark). This is in addition to the "two trailing spaces" hard break form. Default: true.

Enable inline HTML interpretations (e.g. <br>, <u>...</u>). When disabled, HTML tags remain literal text and no HTML decoding is performed.

Examples

var options = new MarkdownReaderOptions {
    HtmlBlocks = false,
    InlineHtml = false,
};
// MarkdownReader.Read("hello", options) keeps the HTML tokens inside text runs.
            

Optional base URI used to resolve relative links/images. When set, relative URLs (not starting with http/https,//,#,mailto:,data:) are converted to absolute using this base during parsing.

When true, blocks scriptable URL schemes (e.g. javascript:, vbscript:) during parsing. If a link/image uses a blocked scheme, it is treated as plain text instead of producing a clickable/linkable node. Default: true.

When true, blocks file: URLs (and Windows drive-like C:\ paths) during parsing. Default: false to preserve legacy behavior for local/offline documents.

When false, mailto: links are treated as plain text. Default: true.

When false, data: URLs are treated as plain text. Default: true.

When false, protocol-relative URLs (//example.com) are treated as plain text. Default: true.

When true, only URL schemes listed in AllowedUrlSchemes are allowed. Relative URLs and fragments are still allowed. Default: false to preserve legacy behavior.

List of allowed URL schemes when RestrictUrlSchemes is enabled. Values are compared case-insensitively and should not include the trailing colon. Default: http, https, mailto.

Optional markdown input normalization before parsing. Defaults are conservative (no transformations).

Optional maximum input length, in characters, accepted by MarkdownReader. When set and exceeded, parsing fails fast with an ArgumentOutOfRangeException.

Optional language-based fenced block factories that can produce specialized AST nodes instead of plain CodeBlock instances. Later registrations win when languages overlap.

Optional block parser extensions layered into the default reader pipeline at named placement anchors. Profiles use this to opt into OfficeIMO/GFM-style non-core block syntax such as callouts, TOC placeholders, and footnotes.

Optional ordered inline parser extensions that get a chance to recognize custom inline tokens before the built-in inline parser handles the current position.

Optional ordered post-parse document transforms. Use these for AST-level upgrades and host-specific semantic rewrites after markdown has been parsed.

Examples

var options = MarkdownReaderOptions.CreatePortableProfile();
options.DocumentTransforms.Add(
    new MarkdownJsonVisualCodeBlockTransform(MarkdownVisualFenceLanguageMode.GenericSemanticFence));

var document = MarkdownReader.Parse(markdown, options);