liemermaid 0.3.1

Mermaid diagram parser + renderer (SVG / vello_cpu PNG), unified through lievisual Scene IR.
Documentation

liemermaid

A Mermaid diagram parser and renderer in pure Rust. Output is built on lievisual's declarative scene IR (Scene) with two backends: SVG and PNG (via vello_cpu). No JavaScript runtime required.

Supported diagrams: flowchart · sequence · class · state · ER · pie · gitgraph · timeline

Quick start

[dependencies]
liemermaid = "0.3"
use liemermaid::{render, render_png};

// Render an SVG string
let svg = render("flowchart TD\n    A[Start] --> B[End]", 800, 600)?;

// Render PNG bytes
let png: Vec<u8> = render_png("pie\n    \"A\": 30\n    \"B\": 50", 600, 400)?;

Canvas semantics (same as official Mermaid): width / height are upper bounds — oversized content is scaled down proportionally and never cropped; content that fits is never scaled up. Use render_with_config / render_png_with_config for custom background colors.

Documentation

Examples

Examples are organized by diagram type and by feature; see examples/README.md.

cargo run --example flowchart_basic
cargo run --example flowchart_subgraph
cargo run --example sequence_blocks
cargo run --example output_formats
cargo run --example output_sketch

Outputs are written to examples/out/.

CLI

cargo install liemermaid
liemermaid-cli -i diagram.mmd -o out.svg        # format inferred from extension
liemermaid-cli -i diagram.mmd -o out.png -W 1200 -H 800

Online demo

A WebAssembly playground that renders Mermaid to SVG/PNG entirely in the browser: zzzdong.github.io/liemermaid (source in site/).

Testing

cargo test

Covers parsing, syntax-compatibility regressions, layout quality (no edge-through-node crossings, layer alignment, no overlap), SVG structure, PNG encoding, pathological inputs, and structural comparison against official mermaid-cli golden output. Official golden SVGs are generated locally with tests/golden/generate_golden.js and are not committed; the comparison test skips automatically when they are absent.

Known limitations

  • Output is structurally close to official Mermaid but not yet pixel-perfect (official uses dagre plus a full theme system).
  • flowchart style / classDef / linkStyle / click statements and classDiagram note for X "..." are safely skipped (no errors). Node style suffixes (A:::class) and the extended shape syntax (A@{ shape: rect }) are accepted, but do not change rendering yet.
  • subgraph nesting and per-subgraph direction are supported: each container is laid out locally after the global pass, so its members may not align with the outer graph's layers.
  • HTML labels / Markdown formatting inside labels are rendered as plain text.
  • CJK text renders correctly, but long CJK strings do not auto-wrap yet.
  • PNG output is capped at 8192×8192 pixels; larger canvases return an error instead of attempting a multi-GB allocation.

License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.