Getting Started
Getting Started with ferromark
ferromark is a Rust Markdown parser built for high-throughput HTML rendering with full CommonMark conformance in trusted rendering mode and a secure-by-default output policy.
What this guide covers
- Quick Start: install and run the core APIs fast.
- Benchmarks: throughput data and comparison setup.
- Features and Flags: everything included in the parser.
- MDX Examples: how to render and segment
.mdxinput.
Why teams use ferromark
- 652/652 CommonMark spec tests pass with trusted rendering; the secure default escapes raw HTML by design and passes 577/652.
- All five GFM extensions are available.
- Additional extensions include footnotes, heading IDs, front matter extraction, math spans, callouts, highlight, superscript, and subscript.
- Throughput reaches 280 MiB/s on CommonMark 50 KB fixtures.
Core API
let html = ferromark::to_html("# Hello\n\n**World**");Use to_html_into to reuse a buffer across calls:
let mut buffer = Vec::new();
ferromark::to_html_into("# Reuse me", &mut buffer);