Choreo.Requirement.Render.Mermaid (Choreo v0.11.0)

Mermaid.js rendering for Choreo.Requirement diagrams.

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

Summary

Functions

Renders a requirements diagram to Mermaid.js requirementDiagram syntax.

Functions

to_mermaid(req, opts \\ [])

@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