Skillget

Pretty-mermaid-skills

agent
Security Audit
Fail
Health Pass
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Community trust — 1128 GitHub stars
Code Fail
  • execSync — Synchronous shell command execution in scripts/batch.mjs
  • execSync — Synchronous shell command execution in scripts/render.mjs
  • spawnSync — Synchronous process spawning in scripts/smoke-test.mjs
  • execSync — Synchronous shell command execution in scripts/themes.mjs
Permissions Pass
  • Permissions — No dangerous permissions requested

No AI report is available for this listing yet.

SUMMARY

AI Agent Skill to generate and render beautiful Mermaid diagrams as SVG or terminal ASCII — 15 themes, 6 diagram types, batch CLI, no browser.

README.md

Pretty Mermaid

Beautiful Mermaid diagrams for AI agents

Turn Mermaid source into polished SVGs and terminal-ready ASCII—locally, without a browser.

Pretty Mermaid converts Mermaid source into themed SVG and terminal ASCII diagrams

skills.sh
License: MIT
Node.js Version
GitHub stars

English ｜ 中文

🚀 Install

npx skills add imxv/pretty-mermaid-skills@pretty-mermaid -g -y

View the skill, install count, and security audits on skills.sh →

Why Pretty Mermaid?

  • Made for AI agents: works with Claude Code, Cursor, Codex, Gemini CLI, and more
  • One source, two outputs: polished SVG for docs and ASCII/Unicode for terminals
  • No browser required: renders locally without Chromium, Puppeteer, or a DOM
  • Flexible by default: 15 themes, custom colors, six diagram types, and batch rendering

✨ Features

  • 📊 Multi-format Support: SVG and ASCII rendering export
  • 🎨 Rich Themes: 15 built-in themes for different scenarios
  • 📈 Six Diagram Types: Flowchart, Sequence, State, Class, ER, and XY charts
  • ⚡ High Performance: Batch parallel rendering
  • 📚 Ready to Use: Complete templates and detailed documentation

Supported Themes

Light Themes Dark Themes Other
zinc-light zinc-dark nord
tokyo-night-light tokyo-night nord-light
catppuccin-latte tokyo-night-storm dracula
github-light catppuccin-mocha one-dark
solarized-light github-dark
solarized-dark

🤖 AI Assistant Integration

Seamlessly integrates with the following AI coding environments:

  • Claude Code
  • Cursor
  • Gemini CLI
  • Antigravity
  • OpenCode
  • Codex
  • qoder

Installation details

Install from GitHub

npx skills add imxv/pretty-mermaid-skills@pretty-mermaid -g -y

Verify Installation

cd Pretty-mermaid
node scripts/themes.mjs

Note: Dependencies will be auto-installed on first run. Just ensure Node.js is available.

📖 Quick Start

List Available Themes

node scripts/themes.mjs

Render Single Diagram

node scripts/render.mjs \
  --input diagram.mmd \
  --output output.svg \
  --theme tokyo-night

Batch Render

node scripts/batch.mjs \
  --input-dir ./diagrams \
  --output-dir ./output \
  --theme dracula

📂 Examples

Check the 6 template files in assets/example_diagrams/:

  • flowchart.mmd - Flowchart
  • sequence.mmd - Sequence Diagram
  • state.mmd - State Diagram
  • class.mmd - Class Diagram
  • er.mmd - ER Diagram
  • xychart.mmd - XY Chart (bar and line)

The renderer also supports CJK state names, multiline labels, linkStyle, configurable ELK layout spacing, interactive XY chart tooltips, and ANSI-colored terminal output.

📚 Documentation

See SKILL.md for detailed usage guide.

⚙️ Requirements

  • Node.js 14+

📄 License

MIT License

Star History

Star History Chart

🙏 Acknowledgments

Based on beautiful-mermaid

Reviews (0)

No results found