Skip to content

to_mermaidchart_url.py

graph_to_mermaidchart_url(graph, base_url='https://www.mermaidchart.com/play', **mermaid_options)

Generate a mermaidchart.com URL for the given graph. Take in mind that this is an external service and your graph data will be sent to their server.

Parameters:

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

tuple of node and IO metadata.

required
base_url str

Base URL for mermaidchart.com

'https://www.mermaidchart.com/play'
mermaid_options Any

Additional options for the mermaid diagram.

{}

Returns:

Type Description
str

The mermaidchart.com URL.