Crate mdwright_document 

Structs

AutolinkFact

One autolink recognised in source.

BlockCheckpointFact

One top-level block checkpoint in canonical source coordinates.

CodeBlock

One fenced or indented code block.

Document

A parsed Markdown document.

ExtensionOptions

Per-extension recognition toggles.

Frontmatter

Frontmatter at the document head. Carries the raw slice plus a tag for which delimiter the source used so the formatter can emit the same opening and closing markers.

GfmOptions

Recognition toggles for GitHub Flavored Markdown extensions.

Heading

One ATX or setext heading. text is the trimmed text content (# markers and trailing whitespace stripped); raw_range covers the whole heading line(s).

HeadingAttrSite

An ATX heading attribute trailer.

HeadingAttrs

Heading attribute trailer recognised on an ATX heading.

HtmlBlock

One HTML block (CommonMark §4.6).

InlineCode

One inline code span. text excludes the surrounding backticks; raw_range covers them.

InlineDelimiterSlot

Delimiter byte slots for one inline span.

InlineHtml

One inline HTML tag (open, close, self-closing, comment, etc.) embedded in a paragraph.

InlineLinkDestinationSlot

An inline link or image destination byte slot.

LineIndex

Maps byte offsets in a source string to 1-indexed (line, column) pairs. Columns count Unicode codepoints, matching what grep -n and most editors display.

LinkDef

One link reference definition ([label]: dest).

ListGroup

A contiguous list at one indentation depth. Nested lists are distinct ListGroup entries.

ListItem

One item within a ListGroup.

MarkdownSignature

A canonical Markdown event stream used for semantic comparison.

MathParseOptions

Math delimiter recognition policy.

MathRegion

One recognised math region in source order.

MystOptions

Recognition toggles for MyST-flavoured extensions.

OrderedListMarkerSite

One ordered list item marker.

PandocOptions

Recognition toggles for Pandoc-flavoured extensions.

ParagraphHardBreak

ParseError

Markdown source could not be parsed safely.

ParseOptions

Markdown recognition policy.

ReferenceDefinitionSite

A link-reference definition destination byte range.

RenderOptions

Rendering policy for source-to-HTML helpers.

StructuralSpan

A recognised block/container range.

Suppression

One inline suppression directive parsed from a Markdown HTML comment.

TableCellSite

One table cell’s source range inside a raw table line.

TableRowSite

One raw table line.

TableSite

One GFM table source range and its source rows.

TextSlice

A borrowed slice of source bytes plus its absolute byte range. The minimal record every rule needs to emit a diagnostic.

UnorderedListMarkerSite

One unordered list item marker.

WrappableParagraph

A paragraph range with the inline facts needed by the wrap pass.

Enums

AllowScope

AutolinkOrigin

Where an autolink came from.

FrontmatterDelimiter

Frontmatter fence style. Yaml uses --- open and ---/... close; Toml uses +++ for both.

GfmAutolinkPolicy

GFM extended-autolink recognition policy.

InlineDelimiterKind

Inline delimiter kind.

LineIndexError

MathDelimiterSet

Named math delimiter sets recognised by the Markdown parser.

MathError

An unrecoverable shape the recogniser saw. The scanner never panics; it accumulates these and keeps scanning the rest of the document.

MathSpan

Per-region classification produced by the scanner.

RenderProfile

HTML spelling policy for crate::render_html_with_render_options.

StructuralKind

Structural owner kinds with source ranges.

SuppressionKind

TableAlign

Column alignment for a recognised GFM table.

Functions

contains_rejected_control_chars

Input-boundary predicate: returns true when s carries a C0 control byte that mdwright treats as evidence the input is not well-formed Markdown.

markdown_signature

Build a semantic signature under explicit recognition policy.

render_html

Render Markdown to HTML using the same parser options the IR uses.

render_html_with_options

Render Markdown to HTML under explicit recognition options.

render_html_with_render_options

Render Markdown to HTML under explicit recognition and render options.