Mermaid Support
Last updated
Last updated
is a diagramming tool that renders Markdown-inspired text definitions into visual diagrams. It is a powerful way to create and visualize various types of diagrams, including flowcharts, sequence diagrams, class diagrams, and more, directly from text.
To generate diagrams by Mermaid:
Select Tools > Generate Diagram by Mermaid menu.
Enter mermaid code and click Generate button.
Select a package where the generated diagram and elements to be contained.
StarUML support the following Mermaid diagrams:
Class Diagram
Sequence Diagram
State Diagram
Flowchart
Entity Relationship Diagram
Requirement Diagram
Mindmap
There may be differences in style, layout, etc. between the diagram generated in StarUML using Mermaid syntax and the actual rendering of Mermaid.
You can create a class diagram with Mermaid. Keep in mind that the class diagram syntax in Mermaid is different from the UML specification. For example, an attribute is written as age: int
in UML, but as int age
in Mermaid. For more details, refer to the official Mermaid documentation.
Here is an example code for class diagram.
Mermaid for StarUML do not support followings in class diagram:
Namespaces
Styling and classes
Markdown formatting
Links
Interactions
A state diagram is a graphical representation of a system that shows its states, transitions, and events. Each state depicts a unique situation in the system, while transitions indicate how the system moves from one state to another based on events or conditions. Here is an example code for state diagram.
Mermaid for StarUML do not support followings in state diagram:
Composite state
Concurrency
Styles and classes
Markdown formatting
A flowchart is a visual representation of a process, system, or algorithm. It uses symbols like arrows, rectangles, ovals, and diamonds to depict the flow of steps, decisions, and information, allowing for easy understanding and communication of complex processes. Here is an example code for flowchart.
Mermaid for StarUML do not support followings in flowchart:
Some node shapes (asymmetric, parallelogram alt, trapezoid, and double circle)
Expanded node shapes and special shapes
Link types and arrow types except solid arrows (means flow)
Animation, interaction, style, classes and icons
Markdown formatting
Subgraph
An Entity Relationship Diagram (ERD) is a graphical representation of entities and their relationships in a database. It is a critical tool in database design that helps visualize how data is structured and how different entities interact within the system. Here is an example code for entity relationship diagram.
Mermaid for StarUML do not support followings in entity relationship diagram:
Markdown formatting
Styling and classes
A requirement diagram is a visual representation used to capture, categorize, and manage requirements in a system or project. Primarily used in systems engineering and software engineering, it helps stakeholders understand requirement relationships and hierarchies. Here is an example code for requirement diagram.
Mermaid for StarUML do not support followings in requirement diagram:
Markdown formatting
Styles and classes
A mindmap is a visual tool used for organizing information hierarchically. It starts with a central idea and branches out into related subtopics, helping to generate, organize, and visualize ideas or concepts. Mindmaps are useful for brainstorming and planning as they encourage a free flow of ideas. Here is an example code for mindmap.
Mermaid for StarUML do not support followings in mindmap:
Node shapes
Icon and classes
Markdown formatting
Please refer to the for the specific Mermaid syntax.