beautiful-mermaid

Render Mermaid diagrams into SVG and PNG with theming options.

102|4|Updated Apr 15, 2009
One-click install
npx skills add https://github.com/mikker/dotfiles --skill beautiful-mermaid-mikker
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: beautiful-mermaid
Source: https://github.com/mikker/dotfiles/tree/main/agents.symlink/skills/beautiful-mermaid
Command: npx skills add https://github.com/mikker/dotfiles --skill beautiful-mermaid-mikker

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires beautiful-mermaid, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Diagram authors often need quick, consistent visualizations of Mermaid diagrams in SVG and PNG formats; this skill automates rendering with reliable theming and an end-to-end workflow.

Core Features & Use Cases

  • Supports Flowchart, Sequence, State, Class, and Entity-Relationship diagrams with multiple themes.
  • Provides an end-to-end rendering workflow: validate or generate Mermaid code, render to SVG, wrap in HTML for stable screenshots, and capture a high-resolution PNG with agent-browser.
  • Works in typical software engineering contexts to generate diagrams for design reviews, documentation, and API specs.

Quick Start

Provide Mermaid code or a file and request rendering to SVG and PNG with a chosen theme.

Frequently Asked Questions about beautiful-mermaid

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

FAQPage Schema
How do I render Mermaid diagrams to SVG and PNG?▼

You can automate Mermaid diagram rendering using the Beautiful Mermaid library, which outputs both SVG and PNG formats. It validates Mermaid code, applies your chosen theme, and executes an end-to-end workflow including HTML wrapping and high-resolution PNG capture.

What diagram types are supported by Beautiful Mermaid rendering?▼

Beautiful Mermaid rendering supports Flowchart, Sequence, State, Class, and Entity-Relationship diagrams. Each diagram type can be rendered with multiple available themes for consistent visual styling in software engineering documentation.

Do I need agent-browser to generate PNG files from Mermaid code?▼

Yes, agent-browser is required for PNG rendering from Mermaid code. The end-to-end workflow renders an SVG first, wraps it in an HTML file for a stable layout, and then uses agent-browser to capture the high-resolution PNG screenshot.

Can I apply custom themes to Mermaid diagrams for design reviews?▼

Yes, you can apply custom theming to Mermaid diagrams for design reviews. The rendering workflow includes theming options that ensure quick and consistent visualizations across Flowchart, Sequence, State, Class, and Entity-Relationship diagrams.

What is the best way to automate diagram generation for API specs?▼

The best way to automate diagram generation for API specs is using an end-to-end Mermaid rendering workflow. It handles validation, SVG rendering, HTML wrapping, and high-resolution PNG capture to produce consistent visualizations for documentation.