Skip to content

to_mermaid_md.py

graph_to_mermaid_md(graph, block_char='`', **mermaid_options)

Generate a mermaid diagram in markdown format.

Parameters:

Name Type Description Default
graph tuple[dict[str, list[NodeData]], dict[str | None, list[IOData]]]

tuple of node and IO metadata.

required
block_char str

character to use for code block fencing

'`'
mermaid_options Any

Additional options for the mermaid diagram.

{}

Returns:

Type Description
str

The mermaid diagram in markdown format.