mermaid-render

Render Mermaid diagrams as ASCII art, GUI views, or PNG/SVG/PDF files.

1|Updated May 15, 2025
One-click install
npx skills add https://github.com/badaniya/.stowed --skill mermaid-render
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mermaid-render
Source: https://github.com/badaniya/.stowed/tree/main/agents/.agents/skills/mermaid-render
Command: npx skills add https://github.com/badaniya/.stowed --skill mermaid-render

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires graph-easy, mermaid-cli, chafa, and includes scripts (resource) components.

What problem does it solve?

This Skill renders Mermaid diagrams into terminal-friendly output: ASCII art for quick readability, a GUI viewer for complex diagrams, or saved image files (PNG/SVG/PDF) for documentation.

Core Features & Use Cases

  • ASCII rendering in the terminal using graph-easy for quick, readable diagrams.
  • GUI viewer support via the -f view option for non-text diagrams.
  • Inline image rendering in terminals that support Kitty graphics (-f image) for high-quality visuals.
  • File export options to PNG, SVG, or PDF for sharing and embedding in reports.
  • Triggered by requests like "render mermaid", "show diagram", or "visualize graph" to produce immediate visuals.

Quick Start

Render ASCII art (default): ~/.agents/skills/mermaid-render/scripts/mermaid-render.sh "graph LR; A[Start] --> B[End]" Open in GUI viewer: ~/.agents/skills/mermaid-render/scripts/mermaid-render.sh -f view "sequenceDiagram; A->>B: Hello" Save as PNG: ~/.agents/skills/mermaid-render/scripts/mermaid-render.sh -f png -o diagram.png "graph TD; A-->B"

Frequently Asked Questions about mermaid-render

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I render Mermaid diagrams as ASCII art directly in the terminal?

You can render Mermaid diagrams as ASCII art in the terminal by passing the diagram syntax to the rendering script, which uses graph-easy to produce readable text-based visuals by default.

Can I export Mermaid diagrams to PNG, SVG, or PDF files for documentation?

Yes, you can export Mermaid diagrams to PNG, SVG, or PDF files by using the file output option, allowing you to save and embed visual graphics directly into your reports and documentation.

Does terminal Mermaid rendering work inside nested tmux sessions?

Yes, terminal Mermaid rendering supports nested tmux scenarios, ensuring that diagram visualization and GUI views remain functional even when operating within complex multiplexer environments.

What is the best way to view complex Mermaid diagrams that do not display well as ASCII text?

The best way to view complex Mermaid diagrams is by using the GUI viewer option, which opens the rendered visual output externally, or by using inline image rendering if your terminal supports Kitty graphics.

Do I need mermaid-cli or graph-easy installed to visualize graphs in the shell?

Yes, you need local tools such as graph-easy, mermaid-cli via mmdc, and chafa installed, as the rendering process relies on these dependencies to generate ASCII art, images, and GUI views.

Can I trigger Mermaid visualization automatically from natural language requests?

Yes, Mermaid visualization is triggered by natural language requests like render mermaid, show diagram, or visualize graph, which immediately produce the requested terminal-friendly or image output.