Module comrak 

CommonMark and GitHub Flavored Markdown parser.

• Crate ::comrak.
• docs.rs
• crates.io
• GitHub

---

comrak is a 100% CommonMark-compatible Markdown parser that also supports GitHub Flavored Markdown (GFM) extensions. It can render Markdown to HTML, CommonMark, or manipulate the AST directly.

The main entry point is markdown_to_html for simple conversions, or parse_document for AST manipulation. Options are configured via Options which controls extensions like tables, strikethrough, and autolinks.

Examples

Basic Markdown to HTML conversion:

use comrak::{markdown_to_html, Options};

let markdown = "# Hello\n\nThis is **bold** and *italic*.";
let html = markdown_to_html(markdown, &Options::default());

assert!(html.contains("<h1>"));
assert!(html.contains("<strong>bold</strong>"));
assert!(html.contains("<em>italic</em>"));

Enabling GitHub Flavored Markdown extensions:

use comrak::{markdown_to_html, Options};

let mut options = Options::default();
options.extension.strikethrough = true;
options.extension.table = true;
options.extension.autolink = true;

let markdown = "~~deleted~~ and https://example.com";
let html = markdown_to_html(markdown, &options);

assert!(html.contains("<del>deleted</del>"));
assert!(html.contains("<a href="));

Modules

adapters

Adapter traits for plugins.

arena_tree

A DOM-like tree data structure based on &Node references.

html

HTML rendering infrastructure for the CommonMark AST, as well as helper functions.

nodes

The CommonMark AST.

options

Configuration for the parser and renderer. Extensions affect both.

plugins

Plugin definitions.

Macros

create_formatter

Create a formatter with specialised rules for certain node types.

node_matches

Shorthand for checking if a node’s value matches the given expression.

Structs

Options

Umbrella options struct.

ResolvedReference

A reference link’s resolved details.

Functions

escape_commonmark_inline

Escapes the input, rendering it suitable for inclusion in a CommonMark document in a place where regular inline parsing is occurring. Note that this is not minimal — there will be more escaping backslashes in the output than is strictly necessary. The rendering will not be affected, however.

escape_commonmark_link_destination

Escapes the input URL, rendering it suitable for inclusion as a link destination per the CommonMark spec.

format_commonmark

Formats an AST as CommonMark, modified by the given options.

format_commonmark_with_plugins

Formats an AST as CommonMark, modified by the given options. Accepts custom plugins.

format_html

Formats an AST as HTML, modified by the given options.

format_html_with_plugins

Formats an AST as HTML, modified by the given options. Accepts custom plugins.

format_xml

Formats an AST as HTML, modified by the given options.

format_xml_with_plugins

Formats an AST as HTML, modified by the given options. Accepts custom plugins.

markdown_to_commonmark

Render Markdown back to CommonMark.

markdown_to_commonmark_xml

Render Markdown to CommonMark XML.

markdown_to_commonmark_xml_with_plugins

Render Markdown to CommonMark XML using plugins.

markdown_to_html

Render Markdown to HTML.

markdown_to_html_with_plugins

Render Markdown to HTML using plugins.

parse_document

Parse a Markdown document to an AST.

version

Return the version of the crate.

Type Aliases

Arena

Convenience type alias for arena used to hold nodes.

Node

A reference to a node in an arena. Unless you are manually creating nodes before the arena, this is the type you will see most often.