mermaid-visualizer

axtonliu/axton-obsidian-visual-skills · updated Apr 8, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/axtonliu/axton-obsidian-visual-skills --skill mermaid-visualizer
0 commentsdiscussion
summary

Convert text content into professional Mermaid diagrams with automatic syntax error prevention.

  • Supports six diagram types: process flows, circular cycles, comparisons, mindmaps, sequence diagrams, and state diagrams
  • Handles common syntax pitfalls automatically (list conflicts, subgraph naming, special characters) to ensure rendering in Obsidian, GitHub, and other Mermaid platforms
  • Configurable layout direction, detail level (simple to detailed), and professional color schemes with s
skill.md

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

❌ WRONG: [1. Perception]       → Triggers "Unsupported markdown: list"
✅ RIGHT: [1.Perception]         → Remove space after period
✅ RIGHT: [① Perception]         → Use circled numbers (①②③④⑤⑥⑦⑧⑨⑩)
✅ RIGHT: [(1) Perception]       → Use parentheses
✅ RIGHT: [Step 1: Perception]   → Use "Step" prefix

Rule 2: Subgraph Naming

❌ WRONG: subgraph AI Agent Core  → Space in name without quotes
✅ RIGHT: subgraph agent["AI Agent Core"]  → Use ID with display name
✅ RIGHT: subgraph agent          → Use simple ID only

Rule 3: Node References

❌ WRONG: Title --> AI Agent Core  → Reference display name directly
✅ RIGHT: Title --> agent          → Reference subgraph ID

Rule 4: Special Characters in Node Text

✅ Use quotes for text with spaces: ["Text with spaces"]
✅ Escape or avoid: quotation marks → use 『』instead
✅ Escape or avoid: parentheses → use 「」instead
✅ Line breaks in circle nodes only: ((Text<br/>Break))

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

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

User: "Visualize the software development lifecycle"
Response: [Analyze → Choose graph TB → Generate with standard detail]

Pattern 2: With configuration

User: "Create a horizontal flowchart of our sales process with lots of detail"
Response: [Analyze → Choose graph LR → Generate with detailed level]

Pattern 3: Comparison

User: "Compare traditional AI vs AI agents"
Response: [Analyze → Choose comparison layout → Generate with contrasting styles]

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 code fence
    • Add brief explanation of diagram structure
    • Mention rendering compatibility (Obsidian, GitHub, etc.)
    • Offer to adjust or create variations

Color Scheme Defaults

Standard professional palette:

  • Green (#d3f9d8/#2f9e44): Input, perception, start states
  • Red (#ffe3e3/#c92a2a): Planning, decision points
  • Purple (#e5dbff/#5f3dc4): Processing, reasoning
  • Orange (#ffe8cc/#d9480f): Actions, tool usage
  • Cyan (#c5f6fa/#0c8599): Output, execution, results
  • Yellow (#fff4e6/#e67700): Storage, memory, data
  • Pink (#f3d9fa/#862e9c): Learning, optimization
  • Blue (#e7f5ff/#1971c2): Metadata, definitions, titles
  • Gray (#f8f9fa/#868e96): Neutral elements, traditional systems

Common Patterns

Swimlane Pattern (Grouping)

graph TB
    subgraph core["Core Process"]
        A --> B --> C
    end
    subgraph support["Supporting Systems"]
        D
        E
    end
    core -.-> support

Feedback Loop Pattern

graph TB
    A[Start] --> B[Process]
    B --> C[End]
    C -.->|Feedback| A

Hub and Spoke Pattern

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:

how to use mermaid-visualizer

How to use mermaid-visualizer on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • Cursor installed and configured on your development machine
  • Node.js version 16.0+ with npm package manager (verify with node --version)
  • Active project directory or workspace where you want to add mermaid-visualizer
2

Execute installation command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/axtonliu/axton-obsidian-visual-skills --skill mermaid-visualizer

The skills CLI fetches mermaid-visualizer from GitHub repository axtonliu/axton-obsidian-visual-skills and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/mermaid-visualizer

Reload or restart Cursor to activate mermaid-visualizer. Access the skill through slash commands (e.g., /mermaid-visualizer) or your agent's skill management interface.

Security & Verification Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

List & Monetize Your Skill

Submit your Claude Code skill and start earning

GET_STARTED →

Use Cases

Task Automation & Efficiency

Automate repetitive workflows and reduce manual effort

Example

Generate reports, summarize documents, draft communications

Save 3-5 hours per week on routine tasks

Knowledge Enhancement

Learn new skills, understand complex topics, get expert guidance

Example

Explain concepts, provide examples, suggest learning resources

Accelerate learning and skill development by 2x

Quality Improvement

Enhance output quality through reviews, suggestions, and refinements

Example

Review drafts, suggest improvements, catch errors

Improve work quality by 30-40% with less effort

Implementation Guide

Prerequisites

  • Claude Desktop or compatible AI client with skill support
  • Clear understanding of task or problem to solve
  • Willingness to iterate and refine outputs

Time Estimate

15-45 minutes depending on use case complexity

Installation Steps

  1. 1.Install skill using provided installation command
  2. 2.Test with simple use case relevant to your work
  3. 3.Evaluate output quality and relevance
  4. 4.Iterate on prompts to improve results
  5. 5.Integrate into regular workflow if valuable

Common Pitfalls

  • Expecting perfect results without iteration
  • Not providing enough context in prompts
  • Using skill for tasks outside its intended scope
  • Accepting outputs without review and validation

Best Practices

✓ Do

  • +Start with clear, specific prompts
  • +Provide relevant context and constraints
  • +Review and refine all outputs before using
  • +Iterate to improve output quality
  • +Document successful prompt patterns

✗ Don't

  • Don't use without understanding skill limitations
  • Don't skip validation of outputs
  • Don't share sensitive information in prompts
  • Don't expect skill to replace human judgment

💡 Pro Tips

  • Be specific about desired format and style
  • Ask for multiple options to choose from
  • Request explanations to understand reasoning
  • Combine AI efficiency with human expertise

When to Use This

✓ Use When

Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.

✗ Avoid When

Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.

Learning Path

  1. 1Familiarize yourself with skill capabilities and limitations
  2. 2Start with low-risk, non-critical tasks
  3. 3Progress to more complex and valuable use cases
  4. 4Build expertise through regular use and experimentation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.668 reviews
  • Dhruvi Jain· Dec 24, 2024

    I recommend mermaid-visualizer for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Kiara Tandon· Dec 24, 2024

    We added mermaid-visualizer from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Zaid Patel· Dec 20, 2024

    mermaid-visualizer reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Nikhil Rahman· Dec 8, 2024

    mermaid-visualizer reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Li Diallo· Nov 27, 2024

    mermaid-visualizer has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Rahul Santra· Nov 23, 2024

    Useful defaults in mermaid-visualizer — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Oshnikdeep· Nov 15, 2024

    Solid pick for teams standardizing on skills: mermaid-visualizer is focused, and the summary matches what you get after install.

  • Kwame Flores· Nov 15, 2024

    mermaid-visualizer fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.

  • Yusuf Martinez· Nov 11, 2024

    mermaid-visualizer has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Xiao Bhatia· Oct 18, 2024

    mermaid-visualizer fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.

showing 1-10 of 68

1 / 7