mermaid

Solid

Create, theme, validate, and embed Mermaid diagrams as the default text-based diagram format for GitHub, Slidev, documentation, and technical communication.

AI & Automation 4 stars 1 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
23
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Mermaid Diagram Standard Mermaid is the default diagram format because the same editable text can render directly in GitHub Markdown and inside Slidev decks. Keep the source portable, reviewable, and close to the prose it explains. ## Decision Boundary - Use Mermaid for flowcharts, sequences, states, classes, entity relationships, timelines, mind maps, Git graphs, and other compact technical visuals. - Use [LikeC4](https://likec4.dev/) instead when the architecture model is the durable source of truth and must generate multiple consistent views. - Use [D2](../d2/SKILL.md) instead for an existing D2 codebase or a bespoke standalone composition that Mermaid cannot express clearly. - Omit the diagram when prose, code, a short list, or a table communicates the point more directly. ## Workflow 1. State one visual thesis and the reader decision it supports. 1. Choose the simplest stable diagram type supported by every target renderer. Prefer `flowchart`, `sequenceDiagram`, `stateDiagram-v2`, `classDiagram`, and `erDiagram` for GitHub and Slidev portability. 1. Write the editable source as a fenced `mermaid` block when it belongs to one Markdown document, or as a `.mmd` file when it is reused or rendered independently. 1. Keep labels short, relationships explicit, direction intentional, and the node count small enough to read without zooming. 1. Use Mermaid frontmatter for configuration. Do not add deprecated `%%{init: ...}%%` directives to new diagrams. 1. Apply the Fmind th...

Details

Author
fmind
Repository
fmind/dotfiles
Created
4 months ago
Last Updated
yesterday
Language
Go
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category