Awesome-omni-skill beautiful-mermaid
Render Mermaid diagrams as pure ASCII text (default) or themed SVGs using the beautiful-mermaid renderer. Use when the user asks for a Mermaid diagram (flowchart, sequence, class, state, or ER), wants a diagram file generated, or needs terminal-friendly ASCII output.
install
source · Clone the upstream repo
git clone https://github.com/diegosouzapw/awesome-omni-skill
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/diegosouzapw/awesome-omni-skill "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data-ai/beautiful-mermaid" ~/.claude/skills/diegosouzapw-awesome-omni-skill-beautiful-mermaid && rm -rf "$T"
manifest:
skills/data-ai/beautiful-mermaid/SKILL.mdsource content
Beautiful Mermaid
Overview
Render Mermaid source into pure ASCII text (default) or themed SVGs using a local script powered by the
beautiful-mermaid package.
Quick Start
Install once per machine (from the skill folder) before first use.
- Install dependencies once per machine:
bun install - Render pure ASCII (default):
bun run scripts/render-mermaid.ts < diagram.mmd - Render SVG:
bun run scripts/render-mermaid.ts --format svg --theme tokyo-night --out /tmp/diagram.svg < diagram.mmd
Workflow
- Clarify output target if needed (SVG vs ASCII/Unicode, theme, file path).
- Produce Mermaid source.
- Run the renderer script (prefer stdin pipe over temp files).
- Return both the Mermaid source and the rendered output or file path.
Best Practice: Use
echo '...' | bun run scripts/render-mermaid.ts to pass Mermaid source directly via stdin, avoiding temporary file creation.
CLI Options
Core
(default:--format svg|ascii
)ascii
(else read from stdin)--input <file>
(else write to stdout)--out <file>
(one of the built-in themes, for SVG format)--theme <name>
SVG styling
--bg <hex>--fg <hex>--accent <hex>--muted <hex>--surface <hex>--border <hex>--line <hex>--font <family>--transparent
ASCII styling
(use pure--use-ascii
ASCII style, enabled by default)+---+--padding-x <n>--padding-y <n>--box-border-padding <n>
(convert to fullwidth characters, enabled by default)--fullwidth
Script
scripts/render-mermaid.ts renders Mermaid from stdin or a file into SVG or ASCII/Unicode.