Getting started

Ferrigura renders Mermaid diagram text to standalone SVG in Rust. Start with the command-line tool to render a file, or embed the library in your application. The rendering process needs no browser.

Render a file

Install the published command-line tool:

cargo install --locked ferrigura-cli

Save a diagram as review.mmd:

flowchart TD
  draft[Draft] --> review{Review}
  review -->|Approved| publish[Publish]
  review -->|Changes| draft

Render it to SVG:

ferrigura --id review --scheme light -o review.svg review.mmd

The SVG contains its labels as text and embeds subsets of the fonts it uses. Open the file in an SVG viewer, include it in a page, or keep it as a build artifact. The CLI reference covers stdin, batch output, configuration and exit codes.

Use the Rust library

cargo add ferrigura

use ferrigura::Value;

let svg = ferrigura::render(
    "flowchart LR\n  A[Draft] --> B[Published]\n",
    &Value::empty_object(),
)?;

For many diagrams, reuse a Renderer with one resolved configuration. Give inline diagrams unique IDs when combining them on one page. The Rust reference includes complete examples, configuration, themes and render options.

Node.js integration

The native Node.js addon can be built from the repository. Its prepared npm facade is @ferrigura/core; installation from npm is unavailable until registry bootstrap is complete. Use the addon instructions for a local build, and the distribution reference for its package and platform contract.

The optional Ferromark adapter renders Mermaid fences in custom builds. It is not included in Ferromark’s standard npm addon. See the Ferromark integration guide for that build path.

Know the supported scope

Ferrigura ports Mermaid 12.2.0. Its diagram reference documents coverage and limits for each type. SVG is the output format; browser interactions, math labels, classic themes and some font coverage are outside the supported scope.

Read how output differs from Mermaid before replacing an existing renderer. For reproducible gantt output, supply RenderOptions::now when the diagram depends on the current date.