Syntax

Node Shapes

Nodes can have different shapes defined by the |shape property (or shorthand like |cyl).

Shape
Description
Use Case

rect

Rounded Rectangle (Default)

Standard component

cyl

Cylinder

Database / Storage

cloud

Cloud

External Network / Internet

diamond

Diamond

Decision / Gateway

hex

Hexagon

Service / API

oval

Oval

Start / End

doc

Document

File / Document

grp

Group Box

Transparent container

Example:

db:My Database|cyl
decision:Check Login|diamond

Edge Types

Connections between nodes can be styled using different operators.

Operator
Type
Usage

->

Solid Arrow

Synchronous call, primary flow

-->

Dashed Arrow

Response, async message, dependency

..

Dotted Line

Weak relationship, association

Example:

Node Properties

Properties are added using the pipe | character.

Property
Example
Description

icon

|icon:aws-ec2

Sets the icon inside the node

color

|color:red

Sets the border/stroke color

shape

|shape:cloud

Sets the node shape

group

|group:vpc

Assigns node to a group

tags

|tags:pii,secure

Adds metadata tags

code

|code:block1

Links to a code block

Group Properties

Property
Example
Description

color

|color:blue

Sets the group border color

expandable

|expandable

Makes the group collapsible

Sections

[nodes]

Defines the entities in the graph.

[edges]

Defines the connections between entities.

[groups]

Defines visual containers.

[flow] or [flow:name]

Defines a sequential walk-through of the diagram.

Steps can be:

  • 1:from->to:Label (Highlight an edge)

  • 2:Title|Description (Text-only step)

[nested:group_id]

Defines a sub-diagram inside a group.

[code]

Defines code blocks.

Last updated