Mermex (mermex v0.1.1)

Copy Markdown

Render Mermaid diagrams to SVG using a native Rust renderer.

Wraps the mermaid-rs-renderer Rust crate via Rustler NIFs for fast, browser-free Mermaid-to-SVG conversion.

Summary

Functions

Renders a Mermaid diagram string to an SVG binary.

Like render/1 but raises on error.

Functions

render(diagram)

@spec render(binary()) :: {:ok, binary()} | {:error, binary()}

Renders a Mermaid diagram string to an SVG binary.

Returns {:ok, svg} on success or {:error, reason} on failure.

Examples

iex> {:ok, svg} = Mermex.render("flowchart LR; A-->B-->C")
iex> String.contains?(svg, "<svg")
true

render!(diagram)

@spec render!(binary()) :: binary()

Like render/1 but raises on error.

Examples

iex> svg = Mermex.render!("flowchart LR; A-->B-->C")
iex> String.contains?(svg, "<svg")
true