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/maxpresets or theConstructbuilder instead of setting fields directly. - Parse
Options - Lexing knobs that tune how existing constructs are read or how source text is
preserved, separate from which constructs are recognized (
Constructs). - Syntax
Options - A full syntax configuration: which
Constructsare recognized plus theParseOptionslexing knobs. Build one with a preset (commonmark/gfm/mdx/default), optionally tune it withenable/disable, then callparse.
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 underlyingConstructsflag together. The rawConstructsstruct remains the exhaustive escape hatch for fine-grained control. - Syntax
Config Error - A contradictory
SyntaxOptionsconfiguration, reported bySyntaxOptions::validate. - Wiki
Link Order - Where a wikilink’s display title sits relative to the
|separator. The two orders are mutually exclusive (SyntaxConfigError::WikilinkTitleOrderConflict).