Crate markdown

Public API of markdown-rs.

This module exposes primarily to_html(). It also exposes to_html_with_options() and to_mdast().

• to_html() — safe way to transform (untrusted?) markdown into HTML
• to_html_with_options() — like to_html but lets you configure how markdown is turned into HTML, such as allowing dangerous HTML or turning on/off different constructs (GFM, MDX, and the like)
• to_mdast() — turn markdown into a syntax tree

Features

• default — nothing is enabled by default
• serde — enable serde to serialize the AST (includes dep:serde)
• log — enable logging (includes dep:log); you can show logs with RUST_LOG=debug

Modules

• mdast
  markdown syntax tree: mdast.
• unist
  abstract syntax trees: unist.

Structs

• CompileOptions
  Configuration that describes how to compile to HTML.
• Constructs
  Control which constructs are enabled.
• Options
  Configuration that describes how to parse from markdown and compile to HTML.
• ParseOptions
  Configuration that describes how to parse from markdown.

Enums

• LineEnding
  Type of line endings in markdown.
• MdxExpressionKind
  Expression kind.
• MdxSignal
  Signal used as feedback when parsing MDX ESM/expressions.

Functions

• to_html
  Turn markdown into HTML.
• to_html_with_options
  Turn markdown into HTML, with configuration.
• to_mdast
  Turn markdown into a syntax tree.

Type Definitions

• MdxEsmParse
  Signature of a function that parses MDX ESM.
• MdxExpressionParse
  Signature of a function that parses MDX expressions.