Mermaid macro

Documentation:

https://mermaid.js.org/intro/

Description

Mermaid is a simple markdown-like language for generating flowcharts, diagrams, and graphs. It allows users to describe complex diagrams using a text-based syntax, which is then rendered into graphical representations.

Supported diagram formats

• Sequence Diagram

• Class Diagram

• State Diagram

• Entity Relationship Diagram

• User Journey

• Gantt

• Pie Chart

• Quadrant Chart

• Requirement Diagram

• Gitgraph (Git) Diagram

• C4 Diagram

• Mindmaps

• Timeline

• Sankey (experimental)

• XY Chart

• Block Diagram

Potential use cases

• Flowcharts: Mermaid is commonly used to create flowcharts to visualize processes, workflows, and decision trees.

• Sequence Diagrams: It is used to create sequence diagrams, which illustrate the flow of messages between different components or actors in a system.

• Gantt Charts: Mermaid supports Gantt charts, which are used for project management to represent project schedules and timelines.

• Class Diagrams: It can be used to create class diagrams to visualize the structure and relationships between classes in object-oriented programming.

• Entity Relationship Diagrams (ERD): Mermaid is suitable for creating ER diagrams to represent the relationships between entities in a database schema.

Examples:

graph TD;
    A[Start] --> B[Process 1];
    B --> C[Process 2];
    C --> D[Process 3];
    D --> E[End];

graph LR
    title("<b>Title</b>")
    node1("<u>Node</u><br>Linebreak")
    title---node1