Expand description
Public API of socketry-markdown.
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 HTMLto_html_with_options()— liketo_htmlbut 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 treeRenderer— render AST nodes and fragments with a user-defined rendererHTMLRenderer— render an AST node or fragment directly as HTMLMarkdownRenderer— render an AST node or fragment back to Markdown
§Features
default— nothing is enabled by defaultlog— enable logging (includesdep:log); you can show logs withRUST_LOG=debugserde— enable serde to serialize ASTs and configuration (includesdep:serde)
Re-exports§
pub use markdown::to_markdown;pub use markdown::to_markdown_with_options;pub use markdown::IndentOptions;pub use markdown::Options as MarkdownOptions;pub use renderer::HTMLRenderer;pub use renderer::MarkdownRenderer;pub use renderer::Renderer;
Modules§
- markdown
- API.
- mdast
- markdown syntax tree: mdast.
- message
- renderer
- Traits for rendering Markdown AST nodes.
- unist
- abstract syntax trees: unist.
Structs§
- Compile
Options - 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.
- Parse
Options - Configuration that describes how to parse from markdown.
Enums§
- Line
Ending - Type of line endings in markdown.
- MdxExpression
Kind - 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 Aliases§
- MdxEsm
Parse - Signature of a function that parses MDX ESM.
- MdxExpression
Parse - Signature of a function that parses MDX expressions.