Skip to main content
Mermaid is a powerful tool for visualizing complex workflows, data models, and system architectures using simple code. Seamlessly integrated into Paradime, it helps data teams document their dbt™ projects and collaborate more effectively by creating professional diagrams directly within their development environment.
Why Use Mermaid in Paradime?
  • AI-Powered Creation: Use DinoAI to generate diagrams from simple prompts, eliminating the need to write complex syntax manually.
  • Simplified Visualization: Transform abstract concepts like data models, ETL processes, and project timelines into clear, visual diagrams.
  • Built for Collaboration: Store .mmd diagram files alongside your dbt™ code, version control them, and share them seamlessly with your team.
  • Real-Time Feedback: Preview your diagrams in real-time while you edit, ensuring quick iterations and accuracy.
From documenting database schemas to mapping workflows and planning releases, Mermaid’s visualizations enhance collaboration and understanding across your data projects.

Getting Started with Mermaid

Creating your first diagram in Paradime is simple using DinoAI:
  1. Launch DinoAI: From Paradime’s Code IDE, access DinoAI to start creating diagrams.
  2. Use a Simple Prompt: Tell DinoAI what kind of diagram you want to create. For example:
  1. Get Your Diagram: DinoAI will generate a complete .mmd file with proper Mermaid syntax.
  2. Preview Your Work: Click the eye icon (👁️) to preview your diagram in real-time as you edit.
  3. Iterate and Refine: Modify the generated .mmd file directly, or ask DinoAI to make specific changes.
Quick Testing: This method is perfect for testing and exploring Mermaid capabilities. For consistent, detailed work with Mermaid diagrams, we recommend using .dinoprompts for more structured and reusable mermaid prompts.

Creating Mermaid Diagrams with .dinoprompts

You can create your own structured, reusable Mermaid prompts in .dinoprompts for consistent diagram generation. These custom prompts are perfect for teams that frequently create similar types of diagrams and want standardized templates. Creating Custom Mermaid Prompts
  1. Add prompts to your .dinoprompts file - Create custom Mermaid prompts.
  1. Customize for your needs - Modify prompts to match your team’s specific diagram requirements
Using Your Custom Mermaid Prompts
  1. Open DinoAI by clicking the DinoAI icon (🪄) in the right panel
  2. Access .dinoprompts by clicking the Prompt icon in the chat input
    • Alternative: Use the bracket symbol shortcut ”[” to quickly find prompts
  3. Select your custom prompt from the dropdown (ex. mermaid_erd)
  4. Choose the diagram type based on the prompt selected
  5. Optional: Add additional context to your prompt like Files, Directories, etc.
  6. Optional: Edit/update prompt based on your specific needs

Common Mermaid Diagram

DinoAI can help you create any Mermaid diagram types. While these represent the most commonly used diagrams for data teams, you’re not limited to only these options - DinoAI can generate any valid Mermaid diagram based on your specific needs.

Architecture Diagrams

Visualize your data infrastructure, including cloud deployments, ETL services, and database organization.

Entity Relationship Diagrams (ERDs)

Map database schemas and relationships between tables to document data models.

Class Diagrams

Model data structures and transformations

Block Diagrams

Create structured layouts of system components and data flows.

Sequence Diagrams

Document ETL processes, API interactions, and data validation workflows.

State Diagrams

Track job executions, pipeline statuses, and system states over time.

User Journey Diagrams

Map system interactions and user access patterns for improved workflows.

ZenUML

Model complex workflows with simplified syntax for sequential processes.

Gantt Diagrams

Plan project timelines, manage task dependencies, and track milestones.

GitGraph Diagrams

Document version control strategies, feature development workflows, and release processes.

Timeline Diagrams

Visualize project roadmaps, historical trends, and key milestones.

Requirement Diagrams

Specify and track feature requirements and dependencies visually.

Pie Charts

Show distributions, allocations, and proportional data in your projects.

XY Charts

Display trends, metrics, and relationships using bar and line charts.

Sankey Diagrams

Visualize data flow volumes, resource usage, and energy transfers.

Quadrant Charts

Analyze impact and priority for features or projects.

Mind Maps

Organize ideas, project requirements, or data models hierarchically.
Each diagram type includes detailed documentation with syntax examples and best practices for data teams.