merman 0.1.0

Rust, headless Mermaid implementation (1:1 parity; pinned to mermaid@11.12.2).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# merman

Headless Mermaid in Rust.

This crate is a convenience wrapper around:

- `merman-core` (parsing + semantic JSON model)
- `merman-render` (layout + parity-focused SVG)

Baseline: Mermaid `@11.12.2` (upstream Mermaid is treated as the spec).

## Features

- `render`: enable layout + SVG rendering APIs
- `raster`: enable PNG/JPG/PDF output via pure-Rust SVG rasterization/conversion

## Quickstart

```rust
use merman_core::{Engine, ParseOptions};
use merman::render::{headless_layout_options, render_svg_sync, sanitize_svg_id, SvgRenderOptions};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let engine = Engine::new();
    let layout = headless_layout_options();
    let svg_opts = SvgRenderOptions {
        diagram_id: Some(sanitize_svg_id("example-diagram")),
        ..Default::default()
    };

    let svg = render_svg_sync(
        &engine,
        "flowchart TD; A-->B;",
        ParseOptions::default(),
        &layout,
        &svg_opts,
    )?
    .unwrap();

    println!("{svg}");
    Ok(())
}
```

For parity policy and gates, see `docs/alignment/STATUS.md` in the repository.