Skip to main content

Module serialize

Module serialize 

Source
Expand description

AST to canonical Markdown. The verbs live on Document (to_markdown / to_markdown_with); SerializeOptions tunes the output style. The document is validated first, so serialization can fail with a SerializeError.

The serializer only renders: each node is written in the spelling the AST records for it, or else by one fixed rule. Text, escapes, and character references are written as recorded, and the output is never parsed back.

Structs§

SerializeOptions
Output-style options for serialization. Defaults: LF, trailing newline, and the list markers and code fences the AST records.

Enums§

BulletMarker
The bullet char SerializeOptions::bullet writes unordered lists with.
LineEnding
The newline style emitted by the serializer.
OrderedDelimiter
The delimiter SerializeOptions::ordered_delimiter writes ordered-list markers with.
SerializeError
Why serialization failed.