mermaid-diagrams
Skill40k starsChanged 40 days agoMITView on GitHub
Comprehensive guide for creating software diagrams using Mermaid syntax. Use when users need to create, visualize, or document software through diagrams including class diagrams (domain modeling, object-oriented design), sequence diagrams (application flows, API interactions, code execution), flowcharts (processes, algorithms, user journeys), entity relationship diagrams (database schemas), C4 architecture diagrams (system context, containers, components), state diagrams, git graphs, pie charts, gantt charts, or any other diagram type. Triggers include requests to "diagram", "visualize", "model", "map out", "show the flow", or when explaining system architecture, database design, code structure, or user/application flows.
- Installs packages
69 other projects use a version of this, 17 of them edited.
Trending
More talk lately.thin dataabout the whole repository
Most recently taken up by
- radiovisual/claude-skillstheir own version, first seen Nov 16, 2026
- Ivan-propio/claude-skillsedited, first seen Nov 16, 2026
- pantheon-org/tekhneedited, first seen Nov 15, 2026
- mikejhill/agent-skillstheir own version, first seen Nov 15, 2026
- MADTeacher/skillstheir own version, first seen Nov 15, 2026
- compozy/compozyedited, first seen Nov 13, 2026
Who's talking about The-Vibe-Company/quivr
- Kimz“39.6k Stars:把內容串流變成可監控知識庫的開源引擎”YouTube · Oct 27, 2026 · 4 views
- @golangoss.bsky.social“quivr (⭐️ 39614) An open-source engine that turns continuous content streams into search and monitoring. …”Bluesky · Oct 29, 2026 · 1 likes
- Kimerd“Turn Content Streams Into Searchable Monitored Knowledge”YouTube · Oct 27, 2026 · 1 views
- @golangoss.bsky.social“quivr (⭐️ 39585) An open-source engine that turns continuous content streams into search and monitoring. …”Bluesky · Oct 14, 2026 · 1 likes
- @golangoss.bsky.social“quivr (⭐️ 39603) An open-source engine that turns continuous content streams into search and monitoring. …”Bluesky · Oct 26, 2026
The biggest 5 of 7 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 7
Talked about on Bluesky, YouTube and the web (7 times).
On Bluesky · 3
- Oct 29, 2026quivr (⭐️ 39614) An open-source engine that turns continuous content streams into search and monitoring. Durable ingestion, hybrid search,… — @golangoss.bsky.social1 likes and repost
- Oct 14, 2026quivr (⭐️ 39585) An open-source engine that turns continuous content streams into search and monitoring. Durable ingestion, hybrid search,… — @golangoss.bsky.social1 likes and repost
- Oct 26, 2026quivr (⭐️ 39603) An open-source engine that turns continuous content streams into search and monitoring. Durable ingestion, hybrid search,… — @golangoss.bsky.social0 likes and reposts · 1 reply
On YouTube · 2
- Oct 27, 202639.6k Stars:把內容串流變成可監控知識庫的開源引擎 — Kimz4 views
- Oct 27, 2026Turn Content Streams Into Searchable Monitored Knowledge — Kimerd1 view
On the web · 2
- Oct 30, 2026The-Vibe-Company/Quivr v2.0.1 on GitHub — newreleases.io
- Sep 19, 2023The-Vibe-Company/Quivr v0.0.76 on GitHub — newreleases.io
Used with
Projects with it also use analytics-metrics, aws-account-management and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
hoodiniSkillanalytics-metrics
Build data visualization and analytics dashboards. Use when creating charts, KPI displays, metrics dashboards, or data visualization components. Triggers on analytics, dashboard, charts, metrics, KPI, data visualization, Recharts.
Also in 3 projects that use this
hoodiniSkillaws-account-management
Manage AWS accounts, organizations, IAM, and billing. Use when setting up AWS Organizations, managing IAM policies, controlling costs, or implementing multi-account strategies. Triggers on AWS Organizations, AWS IAM, AWS billing, Cost Explorer, SCPs, multi-account, AWS SSO, Identity Center.
Also in 3 projects that use this
wpankSkillprofessional-communication
Write effective professional messages for software teams. Use when drafting emails, Slack/Teams messages, meeting agendas, status updates, or translating technical concepts for non-technical audiences. Triggers on email, slack, teams, message, meeting agenda, status update, stakeholder communication, escalation, jargon translation.
Also in 3 projects that use this
LangChainSkilllangchain
Build agents with a prebuilt architecture and integrations for any model or tool. Use when creating tool-calling agents, switching model providers, or adding structured output.
Also in 3 projects that use this
imehrSkillrailway
Railway.com deployment and management - deployment, logs, migrations, troubleshooting, monorepo strategies, security, and CLI reference. Use when deploying to Railway, configuring services, managing environment variables, or debugging deployment issues.
Also in 3 projects that use this
- +7 more from hoodini
Other versions69 projects use a version of this.
Word for word · 14
- QuivrHQ/quivr★ 40k100% same
- pedronauck/skills★ 655100% same
- justinwetch/Skill-RSI★ 21100% same
- eugenepyvovarov/mcpbundler-agent-skills-marketplace★ 12100% same
- michele-prandina/ClaudE2E★ 8100% same
- arnabdeypolimi/claude_code_setup★ 4100% same
- pedropicardi/claude-raid★ 4100% same
- FelipeAngeli/skills★ 2100% same
- lrstanley/skills★ 2100% same
- digitalspeed/claude-code-skillset★ 1100% same
4 more not listed
Edited · 17
- compozy/compozy★ 2.9k96% same
- shep-ai/shep★ 277100% same
- wpank/ai★ 1162% same
- pantheon-org/tekhne★ 1090% same
- CarbeneAI/Forge★ 9100% same
- KumailQazi/krmaazha-binance-mcp★ 4100% same
- betterlmy/agent-skills★ 323% same
- gspencergoog/skills★ 391% same
- rcdelfin/agentkit★ 297% same
- bradcstevens/git-loopy-skills★ 099% same
7 more not listed
Wrote their own version · 38
- langchain-ai/openwiki★ 18ksame name
- openclaw/openclaw-enterprise★ 472same name
- hoodini/ai-agents-skills★ 295same name
- veelenga/claude-mermaid★ 221same name
- magnus919/agent-skills★ 177same name
- sammcj/agentic-coding★ 172same name
- cohen-liel/hivemind★ 108same name
- ccheney/robust-skills★ 60same name
- britt/agent-skills★ 12same name
- tstapler/dotfiles★ 8same name
28 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository46 other files it gives its agents.
- AGENTS.mdAGENTS.md
- quivr-search/AGENTS.mdAGENTS.md
- sdks/AGENTS.mdAGENTS.md
- armada-coordinatorSkill
- armada-runtime-claude-codeSkill
- armada-runtime-conductorSkill
- armada-runtime-herdrSkill
- armada-workerSkill
- ask-mattSkill
- audit-tests-devSkill
- better-uiSkill
- capture-learning-toolsSkill
- codebase-designSkill
- code-reviewSkill
- coordinate-fleetSkill
- design-frontend-devSkill
- diagnosing-bugsSkill
- documentation-writerSkill
- domain-modelingSkill
- emil-design-engSkill
- grillingSkill
- grill-meSkill
- grill-with-docsSkill
- handoffSkill
- humanizerSkill
- implementSkill
- improve-codebase-architectureSkill
- mintlifySkill
- plan-prSkill
- prototypeSkill
- researchSkill
- resolving-merge-conflictsSkill
- review-code-devSkill
- setup-matt-pocock-skillsSkill
- ship-pr-devSkill
- tddSkill
- teachSkill
- to-questionnaireSkill
- to-specSkill
- to-ticketsSkill
- triageSkill
- wait-whatSkill
- wayfinderSkill
- wizardSkill
- writing-docsSkill
- writing-for-agentsSkill
The file
We split this skill into the rules it gives an agent
9 rules. 0 are common, 6 are distinctive, and 3 are very specific to this project.
0
Common
Most of the 50 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Create professional software diagrams using Mermaid's text-based syntax.
- Distinctive: line 12
All Mermaid diagrams follow this pattern:
- Very specific: line 21
Use %% for comments
- Very specific: line 152
Comment Extensively: - Use %% comments to explain complex relationships
- Distinctive: line 173
Available themes: default, forest, dark, neutral, base
- Very specific: line 197
Breaking characters: - Avoid {} in comments, use proper escape sequences for special characters
- Distinctive: line 200
Missing relationships: - Document all important connections between entities
- Distinctive: line 214
Document domain models collaboratively
- Distinctive: line 217
Create living documentation that evolves with code
“Common” is measured: kept by at least 6 in 10 of the 50 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Mermaid Diagramming
Create professional software diagrams using Mermaid's text-based syntax. Mermaid renders diagrams from simple text definitions, making diagrams version-controllable, easy to update, and maintainable alongside code.
Core Syntax Structure
All Mermaid diagrams follow this pattern:
diagramType
definition contentKey principles:
- First line declares diagram type (e.g.,
classDiagram,sequenceDiagram,flowchart) - Use
%%for comments - Line breaks and indentation improve readability but aren't required
- Unknown words break diagrams; parameters fail silently
Diagram Type Selection Guide
Choose the right diagram type:
- Class Diagrams - Domain modeling, OOP design, entity relationships
- Domain-driven design documentation
- Object-oriented class structures
- Entity relationships and dependencies
- Sequence Diagrams - Temporal interactions, message flows
- API request/response flows
- User authentication flows
- System component interactions
- Method call sequences
- Flowcharts - Processes, algorithms, decision trees
- User journeys and workflows
- Business processes
- Algorithm logic
- Deployment pipelines
- Entity Relationship Diagrams (ERD) - Database schemas
- Table relationships
- Data modeling
- Schema design
- C4 Diagrams - Software architecture at multiple levels
- System Context (systems and users)
- Container (applications, databases, services)
- Component (internal structure)
- Code (class/interface level)
- State Diagrams - State machines, lifecycle states
- Git Graphs - Version control branching strategies
- Gantt Charts - Project timelines, scheduling
- Pie/Bar Charts - Data visualization
Quick Start Examples
Class Diagram (Domain Model)
classDiagram
Title -- Genre
Title *-- Season
Title *-- Review
User --> Review : creates
class Title {
+string name
+int releaseYear
+play()
}
class Genre {
+string name
+getTopTitles()
}Sequence Diagram (API Flow)
sequenceDiagram
participant User
participant API
participant Database
User->>API: POST /login
API->>Database: Query credentials
Database-->>API: Return user data
alt Valid credentials
API-->>User: 200 OK + JWT token
else Invalid credentials
API-->>User: 401 Unauthorized
endFlowchart (User Journey)
flowchart TD
Start([User visits site]) --> Auth{Authenticated?}
Auth -->|No| Login[Show login page]
Auth -->|Yes| Dashboard[Show dashboard]
Login --> Creds[Enter credentials]
Creds --> Validate{Valid?}
Validate -->|Yes| Dashboard
Validate -->|No| Error[Show error]
Error --> LoginERD (Database Schema)
erDiagram
USER ||--o{ ORDER : places
ORDER ||--|{ LINE_ITEM : contains
PRODUCT ||--o{ LINE_ITEM : includes
USER {
int id PK
string email UK
string name
datetime created_at
}
ORDER {
int id PK
int user_id FK
decimal total
datetime created_at
}Detailed References
For in-depth guidance on specific diagram types, see:
- references/class-diagrams.md - Domain modeling, relationships (association, composition, aggregation, inheritance), multiplicity, methods/properties
- references/sequence-diagrams.md - Actors, participants, messages (sync/async), activations, loops, alt/opt/par blocks, notes
- references/flowcharts.md - Node shapes, connections, decision logic, subgraphs, styling
- references/erd-diagrams.md - Entities, relationships, cardinality, keys, attributes
- references/c4-diagrams.md - System context, container, component diagrams, boundaries
- references/architecture-diagrams.md - Cloud services, infrastructure, CI/CD deployments
- references/advanced-features.md - Themes, styling, configuration, layout options
Best Practices
- Start Simple - Begin with core entities/components, add details incrementally
- Use Meaningful Names - Clear labels make diagrams self-documenting
- Comment Extensively - Use
%%comments to explain complex relationships - Keep Focused - One diagram per concept; split large diagrams into multiple focused views
- Version Control - Store
.mmdfiles alongside code for easy updates - Add Context - Include titles and notes to explain diagram purpose
- Iterate - Refine diagrams as understanding evolves
Configuration and Theming
Configure diagrams using frontmatter:
---
config:
theme: base
themeVariables:
primaryColor: "#ff6b6b"
---
flowchart LR
A --> BAvailable themes: default, forest, dark, neutral, base
Layout options:
layout: dagre(default) - Classic balanced layoutlayout: elk- Advanced layout for complex diagrams (requires integration)
Look options:
look: classic- Traditional Mermaid stylelook: handDrawn- Sketch-like appearance
Exporting and Rendering
Native support in:
- GitHub/GitLab - Automatically renders in Markdown
- VS Code - With Markdown Mermaid extension
- Notion, Obsidian, Confluence - Built-in support
Export options:
- Mermaid Live Editor - Online editor with PNG/SVG export
- Mermaid CLI -
npm install -g @mermaid-js/mermaid-clithenmmdc -i input.mmd -o output.png - Docker -
docker run --rm -v $(pwd):/data minlag/mermaid-cli -i /data/input.mmd -o /data/output.png
Common Pitfalls
- Breaking characters - Avoid
{}in comments, use proper escape sequences for special characters - Syntax errors - Misspellings break diagrams; validate syntax in Mermaid Live
- Overcomplexity - Split complex diagrams into multiple focused views
- Missing relationships - Document all important connections between entities
When to Create Diagrams
Always diagram when:
- Starting new projects or features
- Documenting complex systems
- Explaining architecture decisions
- Designing database schemas
- Planning refactoring efforts
- Onboarding new team members
Use diagrams to:
- Align stakeholders on technical decisions
- Document domain models collaboratively
- Visualize data flows and system interactions
- Plan before coding
- Create living documentation that evolves with code
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

