Skip to main content

Module options

Module options 

Source
Expand description

Parser configuration: which Markdown constructs are recognized and how.

SyntaxOptions is the entry point — pick a preset, optionally tune it with the Construct builder, then call SyntaxOptions::parse. Constructs is the exhaustive per-feature flag set behind it, and ParseOptions holds the lexing knobs.

Structs§

Constructs
The full set of syntactic constructs the parser may recognize, one boolean per feature. This is the exhaustive escape hatch; most callers use the Constructs::commonmark/gfm/mdx/ max presets or the Construct builder instead of setting fields directly.
ParseOptions
Lexing knobs that tune how existing constructs are read or how source text is preserved, separate from which constructs are recognized (Constructs).
SyntaxOptions
A full syntax configuration: which Constructs are recognized plus the ParseOptions lexing knobs. Build one with a preset (commonmark/gfm/ mdx/default), optionally tune it with enable/disable, then call parse.

Enums§

Construct
A discoverable, typo-proof front door for toggling a syntax feature via SyntaxOptions::enable / SyntaxOptions::disable. Each variant maps to one conceptual feature; grouped features flip every underlying Constructs flag together. The raw Constructs struct remains the exhaustive escape hatch for fine-grained control.
SyntaxConfigError
A contradictory SyntaxOptions configuration, reported by SyntaxOptions::validate.
WikiLinkOrder
Where a wikilink’s display title sits relative to the | separator. The two orders are mutually exclusive (SyntaxConfigError::WikilinkTitleOrderConflict).