Command Line

Ferromark v3 provides a Rust library and Node.js bindings. It does not ship the v1 ferromark command; that command was removed in v2. Use an application script or the retained stdin example.

Render stdin from a repository checkout

printf 'Hello, **world**!\n' | cargo run --quiet --locked -p ferromark --example render_stdin

The example follows Rust rendering defaults, including raw HTML passthrough. For untrusted input, build a small wrapper with sanitize: true using the Rust configuration guide.

For a JavaScript script, start with the Node.js guide. When upgrading from v2, read the v2-to-v3 migration guide. For a v1 upgrade, follow the v1-to-v2 migration guide first, then the v2-to-v3 guide.