mermaid-visualizer
Transform text content into professional Mermaid diagrams for presentations and documentation. Use when users ask to visualize concepts, create flowcharts, or make diagrams from text. Supports process flows, system architectures, comparisons, mindmaps, and more with built-in syntax error prevention.
By axtonliu · 1,597 installs
npx skills add axtonliu/axton-obsidian-visual-skills --skill mermaid-visualizer
Source repository · Upstream listing
Mermaid Visualizer
Overview
Convert text content into clean, professional Mermaid diagrams optimized for presentations and documentation. Automatically handles common syntax pitfalls (list syntax conflicts, subgraph naming, spacing issues) to ensure diagrams render correctly in Obsidian, GitHub, and other Mermaid compatible platforms.
Quick Start
When creating a Mermaid diagram:
1. Analyze the content Identify key concepts, relationships, and flow
2. Choose diagram type Select the most appropriate visualization (see Diagram Types below)
3. Select configuration Determine layout, detail level, and styling
4. Generate diagram Create syntactically correct Mermaid code
5. Output in markdown Wrap in proper code fence with optional explanation
Default assumptions:
Vertical layout (TB) unless horizontal requested
Medium detail level (balanced between simplicity and information)
Professional color scheme with semantic colors
Obsidian/GitHub compatible syntax
Diagram Types
1. Process Flow (graph TB/LR)
Best for: Workflows, decision trees, sequential processes, AI agent architectures
Use when: Content describes steps, stages, or a sequence of actions
Key features:
Swimlanes via subgraph for grouping related steps
Arrow labels for transitions
Feedback loops and branches
Color coded stages
Configuration options:
layout : "vertical" (TB), "horizontal" (LR)
detail : "simple" (core steps only), "standard" (with descriptions), "detailed" (with annotations)
style : "minimal", "professional", "colorful"
2. Circular Flow (graph TD with circular layout)
Best for: Cyclic processes, continuous improvement loops, agent feedback systems
Use when: Content emphasizes iteration, feedback, or circular relationships
Key features:
Central hub with radiating elements
Curved feedback arrows
Clear cycle indicators
3. Comparison Diagram (graph TB with parallel paths)
Best for: Before/after comparisons, A vs B analysis, traditional vs modern systems
Use when: Content contrasts two or more approaches or systems
Key features:
Side by side layout
Central comparison node
Clear differentiation via color/style
4. Mindmap
Best for: Hierarchical concepts, knowledge organization, topic breakdowns
Use when: Content is hierarchical with clear parent child relationships
Key features:
Radial tree structure
Multiple levels of nesting
Clean visual hierarchy
5. Sequence Diagram
Best for: Interactions between components, API calls, message flows
Use when: Content involves communication between actors/systems over time
Key features:
Timeline based layout
Clear actor separation
Activation boxes for processes
6. State Diagram
Best for: System states, status transitions, lifecycle stages
Use when: Content describes states and transitions between them
Key features:
Clear state nodes
Labeled transitions
Start and end states
Critical Syntax Rules
Always follow these rules to prevent parsing errors:
Rule 1: Avoid List Syntax Conflicts
Rule 2: Subgraph Naming
Rule 3: Node References
Rule 4: Special Characters in Node Text
Rule 5: Arrow Types
solid arrow
. dashed arrow (for supporting systems, optional paths)
== thick arrow (for emphasis)
~~~ invisible link (for layout only)
For complete syntax reference and edge cases, see [references/syntax rules.md](references/syntax rules.md)
Configuration Options
All diagrams accept these parameters:
Layout:
direction : "vertical" (TB), "horizontal" (LR), "right to left" (RL), "bottom to top" (BT)
aspect : "portrait" (default), "landscape" (wide), "square"
Detail Level:
simple : Core elements only, minimal labels
standard : Balanced detail with key descriptions (default)
detailed : Full annotations, explanations, and metadata
presentation : Optimized for slides (larger text, fewer details)
Style:
minimal : Monochrome, clean lines
professional : Semantic colors, clear hierarchy (default)
colorful : Vibrant colors, high contrast
academic : Formal styling for papers/documentation
Additional Options:
show legend : true/false Include color/symbol legend
numbered : true/false Add sequence numbers to steps
title : string Add diagram title
Example Usage Patterns
Pattern 1: Basic request
Pattern 2: With configuration
Pattern 3: Comparison
Workflow
1. Understand the content
Identify main concepts, entities, and relationships
Determine hierarchy or sequence
Note any comparisons or contrasts
2. Select diagram type
Match content structure to diagram type
Consider user's presentation context
Default to process flow if ambiguous
3. Choose configuration
Apply user specified options
Use sensible defaults for unspecified options
Optimize for readability
4. Generate Mermaid code
Follow all syntax rules strictly
Use semantic naming (descriptive IDs)
Apply consistent styling
Test for common errors:
No "number. space" patterns in node text
All subgraphs use ID["display name"] format
All node references use IDs not display names
5. Output with context
Wrap in mermaid
graph TB
subgraph core["Core Process"]
A B C
end
subgraph support["Supporting Systems"]
D
E
end
core . support
mermaid
graph TB
A[Start] B[Process]
B C[End]
C . Feedback A
mermaid
graph TB
Central[Hub]
A[Spoke 1] Central
B[Spoke 2] Central
C[Spoke 3] Central
Quality Checklist
Before outputting, verify:
[ ] No "number. space" patterns in any node text
[ ] All subgraphs use proper ID syntax
[ ] All arrows use correct syntax ( , . )
[ ] Colors applied consistently
[ ] Layout direction specified
[ ] Style declarations present
[ ] No ambiguous node references
[ ] Compatible with Obsidian/GitHub renderers
[ ] No Emoji in any node text use text labels or color coding instead
References
For detailed syntax rules and troubleshooting, see:
[references/syntax rules.md](references/syntax rules.md) Complete syntax reference and error prevention