Skip to content

Mermaid Extension Schemas

These TypedDict schemas describe values accepted by the Python mermaid={...} constructor kwarg and the equivalent extensions={"mermaid": {...}} envelope.

c4.contrib.mermaid.extensions.BoundaryExtensions

Bases: TypedDict

Mermaid-specific extension data for boundary elements.

Parameters:

Name Type Description Default
tags

Optional tags for styling or grouping.

required
link

URL link associated with the boundary.

required
type

Optional boundary type rendered as the third Mermaid boundary macro argument.

required

Deployment Node Variants

c4.contrib.mermaid.NodeLeft

Bases: Node

Represents a deployment node aligned to the left in the diagram layout.

Typically used for directional positioning in deployment views.

c4.contrib.mermaid.NodeRight

Bases: Node

Represents a deployment node aligned to the right in the diagram layout.

Useful for controlling horizontal positioning in deployment diagrams.