Ferromark / Shared reference

Documentation

The current release is v3.7.0. Ferromark v3 is a breaking upgrade from v2. Read the v2-to-v3 migration guide before upgrading. For a v1 upgrade, follow the v1-to-v2 migration guide first, then the v2-to-v3 guide.

Ferromark turns Markdown into HTML for publishing tools, documentation sites, and applications. Start with the Rust crate, or use the Node.js bindings from JavaScript and TypeScript. The shared reference covers syntax and rendering behavior.

Rust crate

Build with Rust

Render HTML, inspect the document tree, and connect your own rendering hooks. Arena allocation for content tooling.

Start with Rust

Also available for Node.js

Build with Node.js

A native engine behind a typed JavaScript API. HTML strings, Buffers, metadata, and Ferriki highlighting.

Start with Node.js

For shell scripts, use the CLI guide.

Shared reference

Markdown configuration: syntax choices and defaults.
Markdown syntax: the CommonMark and GFM starting point.
Ferromark Flavored Markdown: opt-in publishing syntax and examples.
Content pipelines: metadata, headings, links, and presentation.
Document analysis: reference inventories, text and search sections, and static Markdown export.
Highlighting and diagrams: optional engines, native plugin bundles, and release availability.
Rendering and trust: HTML policy, compatibility, and limits.
MDX boundaries: what MDX integration does and which API exposes it.

Engineering and evidence

Architecture, parser benchmarks, and runtime profiles explain the implementation and measured trade-offs. Explore performance reports to choose the relevant study.