home / skills / jjuidev / jss / mermaidjs-v11

mermaidjs-v11 skill

/.claude/skills/mermaidjs-v11

This skill helps you create Mermaid.js v11 diagrams quickly, converting code into SVG/PNG/PDF and embedding in markdown or webpages.

npx playbooks add skill jjuidev/jss --skill mermaidjs-v11

Review the files below or copy the command above to add this skill to your agents.

Files (6)
SKILL.md
2.8 KB
---
name: mermaidjs-v11
description: Create diagrams with Mermaid.js v11 syntax. Use for flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, state diagrams, architecture diagrams, timelines, user journeys.
---

# Mermaid.js v11

## Overview

Create text-based diagrams using Mermaid.js v11 declarative syntax. Convert code to SVG/PNG/PDF via CLI or render in browsers/markdown files.

## Quick Start

**Basic Diagram Structure:**
```
{diagram-type}
  {diagram-content}
```

**Common Diagram Types:**
- `flowchart` - Process flows, decision trees
- `sequenceDiagram` - Actor interactions, API flows
- `classDiagram` - OOP structures, data models
- `stateDiagram` - State machines, workflows
- `erDiagram` - Database relationships
- `gantt` - Project timelines
- `journey` - User experience flows

See `references/diagram-types.md` for all 24+ types with syntax.

## Creating Diagrams

**Inline Markdown Code Blocks:**
````markdown
```mermaid
flowchart TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Action]
    B -->|No| D[End]
```
````

**Configuration via Frontmatter:**
````markdown
```mermaid
---
theme: dark
---
flowchart LR
    A --> B
```
````

**Comments:** Use `%% ` prefix for single-line comments.

## CLI Usage

Convert `.mmd` files to images:
```bash
# Installation
npm install -g @mermaid-js/mermaid-cli

# Basic conversion
mmdc -i diagram.mmd -o diagram.svg

# With theme and background
mmdc -i input.mmd -o output.png -t dark -b transparent

# Custom styling
mmdc -i diagram.mmd --cssFile style.css -o output.svg
```

See `references/cli-usage.md` for Docker, batch processing, and advanced workflows.

## JavaScript Integration

**HTML Embedding:**
```html
<pre class="mermaid">
  flowchart TD
    A[Client] --> B[Server]
</pre>
<script src="https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.min.js"></script>
<script>mermaid.initialize({ startOnLoad: true });</script>
```

See `references/integration.md` for Node.js API and advanced integration patterns.

## Configuration & Theming

**Common Options:**
- `theme`: "default", "dark", "forest", "neutral", "base"
- `look`: "classic", "handDrawn"
- `fontFamily`: Custom font specification
- `securityLevel`: "strict", "loose", "antiscript"

See `references/configuration.md` for complete config options, theming, and customization.

## Practical Patterns

Load `references/examples.md` for:
- Architecture diagrams
- API documentation flows
- Database schemas
- Project timelines
- State machines
- User journey maps

## Resources

- `references/diagram-types.md` - Syntax for all 24+ diagram types
- `references/configuration.md` - Config, theming, accessibility
- `references/cli-usage.md` - CLI commands and workflows
- `references/integration.md` - JavaScript API and embedding
- `references/examples.md` - Practical patterns and use cases

Overview

This skill creates text-based diagrams using Mermaid.js v11 declarative syntax and converts them to SVG/PNG/PDF for documentation, presentations, or web embedding. It supports 24+ diagram types including flowcharts, sequence diagrams, class and ER diagrams, Gantt charts, state diagrams, timelines, and user journeys. Use it to keep diagrams versionable, editable in plain text, and reproducible via CLI or web rendering.

How this skill works

Write diagrams in Mermaid v11 syntax inside code blocks or .mmd files and render them with the Mermaid CLI or the browser runtime. The CLI (mmdc) converts .mmd files to SVG/PNG/PDF and supports themes, custom CSS, and transparent backgrounds. In browsers or markdown, include the mermaid script and initialize it to render diagrams on page load.

When to use it

  • Documenting system architecture or sequence flows in code repositories
  • Embedding diagrams in markdown-based docs or knowledge bases
  • Generating printable diagrams from version-controlled source files
  • Prototyping user journeys, state machines, or project timelines
  • Automating bulk conversion of diagram files to images in CI

Best practices

  • Keep diagram logic small and focused; split large diagrams into modular files
  • Use frontmatter for consistent theme and rendering options across files
  • Include comments (%%) to explain complex sections without affecting output
  • Store .mmd files in version control to track changes and review diffs
  • Use mmdc with --cssFile for consistent styling across exports

Example use cases

  • Flowchart showing onboarding steps for a web application
  • Sequence diagram illustrating API calls between microservices
  • Class diagram for data model documentation in a backend project
  • Gantt chart for sprint planning and release timelines
  • ER diagram mapping database tables and relationships for design reviews

FAQ

How do I convert .mmd files to PNG or SVG?

Install the Mermaid CLI (npm install -g @mermaid-js/mermaid-cli) and run mmdc -i input.mmd -o output.svg (or .png). Use -t to set theme and --cssFile to apply custom styles.

Can I render Mermaid diagrams directly in HTML or markdown?

Yes. Embed your diagram in a <pre class="mermaid"> block and include the mermaid runtime script, then call mermaid.initialize({ startOnLoad: true }) to render on page load.