Overview
Marmaid’s ZenUML is a specialized feature within Mermaid that allows users to create sequence diagrams efficiently. It provides an intuitive syntax for representing interactions between processes or entities over time. This documentation serves as a comprehensive guide to understanding and using ZenUML within the Mermaid framework.Creating Your First ZenUML
To get started with ZenUML in Paradime, follow these steps:- Launch DinoAI: From Code IDE, access DinoAI to start creating diagrams.
- Use a Simple Prompt: Tell DinoAI what kind of ZenUML Diagram you want to create. For example:
- Get Your Diagram: DinoAI will generate a complete
.mmdfile with proper Mermaid syntax. - Preview Your Work: Click the eye icon (👁️) to preview your diagram in real-time as you edit.
- Iterate and Refine: Modify the generated
.mmdfile directly, or ask DinoAI to make specific changes.
Example:
Reusable ZenUML Diagrams prompts for you and your teamYou can create custom, standardized .dinoprompts for Mermaid’s ZenUML Diagram that ensure consistency across your data team. See step-by-step guide.
Syntax and Features
Participants
Participants in ZenUML are the entities or actors involved in the diagram. They can be defined implicitly or explicitly. Implicit Declaration Participants are automatically defined based on their appearance in the diagram. Explicit Declaration You can explicitly declare participants to define their order of appearance.Annotators
Annotators allow you to specify the type of participant using predefined symbols. Available annotators include:@Actor@Database@Entity
Aliases
Use aliases to assign a convenient identifier to participants.Advanced Features
Messages
ZenUML supports various message types:- Sync Message: Represents a blocking call.
- Async Message: Represents a non-blocking call.
- Creation Message: Creates a new entity.
- Reply Message: Returns a result from a call.
Loops and Conditions
ZenUML enables you to represent loops, conditions, and alternative paths with intuitive syntax. Loops ConditionsStyling and Customization
You can style ZenUML diagrams using Mermaid’s class definitions and themes. Define and apply classes to enhance the visual appeal of your diagrams.Integration
ZenUML can be integrated into web pages using Mermaid’s experimental lazy loading and async rendering features.Additional ResourcesFor more syntax options and advanced features, visit the official Mermaid documentation.