Documentation

Ferromark v2 is in release-candidate testing. Read the migration guide before upgrading.

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: author-facing examples and extensions.
Content pipelines: metadata, headings, links, and presentation.
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.