diegosouzapw 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
--format svg|ascii(default:ascii)--input <file>(else read from stdin)--out <file>(else write to stdout)--theme <name>(one of the built-in themes, for SVG format)
SVG styling
--bg <hex>--fg <hex>--accent <hex>--muted <hex>--surface <hex>--border <hex>--line <hex>--font <family>--transparent
ASCII styling
--use-ascii(use pure+---+ASCII style, enabled by default)--padding-x <n>--padding-y <n>--box-border-padding <n>--fullwidth(convert to fullwidth characters, enabled by default)
Script
scripts/render-mermaid.ts renders Mermaid from stdin or a file into SVG or ASCII/Unicode.