wbd-mermaid-as-code

Teaches Mermaid syntax for flowchart, sequence, state, and ER diagrams embedded in GitHub markdown.

2|Updated Jun 1, 2026
One-click install
npx skills add https://github.com/jay-steenbergen/MSSAMentorAgent --skill wbd-mermaid-as-code-jay-steenbergen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wbd-mermaid-as-code
Source: https://github.com/jay-steenbergen/MSSAMentorAgent/tree/main/.github/skills/tracks/whiteboarding/wbd-mermaid-as-code
Command: npx skills add https://github.com/jay-steenbergen/MSSAMentorAgent --skill wbd-mermaid-as-code-jay-steenbergen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Hand-drawn whiteboard diagrams get erased, and PNG diagrams committed to repos produce unreadable diffs and go stale. This Skill guides learners through writing diagrams as Mermaid text that renders natively in GitHub READMEs, PRs, and VS Code, so architecture documentation lives in version control alongside the code. ## Core Features & Use Cases - Four diagram types in Mermaid: Drills flowchart (graph LR), sequence (sequenceDiagram), state (stateDiagram-v2), and ER (erDiagram) syntax with shape, arrow, and crow's-foot notation references. - Diagrams-as-code workflow: Walks through installing the Markdown Preview Mermaid extension in VS Code, embedding Mermaid in a README, pushing to GitHub, and reviewing diagram changes via commit diffs. - Tool selection guidance: Provides a decision table for choosing between whiteboard sketching, Mermaid, and Draw.io based on audience and durability needs. - Use Case: A learner who completed hand-drawn diagram exercises translates their deployment runbook, login sequence, order state machine, and e-commerce ER model into Mermaid, commits them to a GitHub repo, and sees them render in the README. ## Quick Start Ask the mentor to start the Mermaid diagrams-as-code project and walk you through rendering your first flowchart in VS Code.

Frequently Asked Questions about wbd-mermaid-as-code

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

FAQPage Schema
How do I render Mermaid diagrams in VS Code?

Install the Markdown Preview Mermaid Support extension by Matt Bierner, then open a markdown file containing a fenced code block tagged with mermaid. Use Ctrl+K V for a split preview or Ctrl+Shift+V for a full preview to see the rendered diagram.

Does GitHub render Mermaid diagrams in README files?

Yes, GitHub has rendered Mermaid natively in READMEs, issues, pull requests, and discussions since 2022. Push a markdown file with a mermaid-tagged code block and it displays as a diagram without any reader-side extension.

Mermaid vs PlantUML vs D2 for diagrams as code?

All three are solid text-based diagramming tools. Mermaid wins on portability because it renders natively in GitHub and VS Code without requiring readers to install anything, which is why this project starts with it.

Why is my Mermaid block showing as plain code instead of a diagram?

The most common cause is forgetting the mermaid language tag after the opening triple backticks, which makes the block render as plain code. Also confirm the Mermaid preview extension is installed, since VS Code's built-in markdown preview lacks Mermaid support.

When should I use a whiteboard instead of Mermaid?

Use a whiteboard or Excalidraw for live brainstorming and in-meeting sketching where speed matters. Use Mermaid for architecture docs in repos, PR descriptions, and READMEs where the diagram must stay current, diff cleanly, and survive code review.