# `Choreo.Requirement.Render.Mermaid`
[🔗](https://github.com/code-shoily/choreo/blob/v0.14.1/lib/choreo/requirement/render/mermaid.ex#L1)

Mermaid.js rendering for `Choreo.Requirement` diagrams.

Produces native `requirementDiagram` syntax with requirements, elements,
and traceability relationships.

# `to_mermaid`

```elixir
@spec to_mermaid(Choreo.Requirement.t(), keyword()) :: String.t()
```

Renders a requirements diagram to Mermaid.js `requirementDiagram` syntax.

## Options

  * `:direction` — `:td` (default), `:lr`, `:rl`, `:bt`

## Examples

    iex> req = Choreo.Requirement.new()
    ...>   |> Choreo.Requirement.add_requirement(:a, id: "R1", text: "A")
    iex> mermaid = Choreo.Requirement.Render.Mermaid.to_mermaid(req)
    iex> String.contains?(mermaid, "requirementDiagram")
    true

---

*Consult [api-reference.md](api-reference.md) for complete listing*