SPB Git
4.8 KB · 167 lines json
1{2  "slug": "mermaid",3  "name": "Mermaid",4  "aliases": [5    "Mermaid.js",6    "Mermaid Live Editor",7    "Mermaid Chart"8  ],9  "vendor": {10    "name": "Mermaid project (Knut Sveidqvist and contributors)",11    "slug": "mermaid-js",12    "website": "https://mermaid.js.org"13  },14  "homepage_url": "https://mermaid.js.org/",15  "docs_url": "https://mermaid.js.org/intro/",16  "repo_url": "https://github.com/mermaid-js/mermaid",17  "license_url": "https://github.com/mermaid-js/mermaid/blob/develop/LICENSE",18  "product_type": "library",19  "product_status": "active",20  "summary": "JavaScript library that renders flowcharts, sequence, class, state, ER, Gantt and other diagrams from a Markdown-like text syntax",21  "description": "Mermaid is an open-source JavaScript diagramming library created by Knut Sveidqvist that turns a concise text syntax into SVG diagrams: flowcharts, sequence, class, state and entity-relationship diagrams, Gantt charts, Git graphs, mind maps, timelines, pie and quadrant charts and more. Because diagrams are plain text, they can be versioned with code and rendered wherever the library is embedded, including GitHub and GitLab Markdown, Notion, Obsidian, Docusaurus, MkDocs and VS Code. A command-line tool (mermaid-cli) renders to SVG, PNG or PDF for documents, and the Mermaid Live Editor provides instant preview; the maintainers also run Mermaid Chart, a commercial editor and collaboration service. Layout is automatic and offers limited manual control, complex diagrams can render awkwardly, and syntax details differ between diagram types and versions.",22  "capabilities": [23    "Text-to-diagram rendering for many diagram types",24    "SVG output embeddable in web pages and Markdown",25    "Theming and configuration directives",26    "mermaid-cli for batch rendering to SVG, PNG and PDF",27    "Live Editor for interactive preview",28    "Native support in GitHub, GitLab and many documentation tools"29  ],30  "workflows": [31    "Keep architecture diagrams as text in a repository and render them in docs",32    "Generate a sequence diagram from a specification and export to PDF for a paper"33  ],34  "advantages": [35    "MIT license and ubiquitous rendering support",36    "Diagrams versioned as plain text"37  ],38  "limitations": [39    "Little manual control over layout",40    "Complex diagrams can be hard to read",41    "Syntax varies across diagram types"42  ],43  "prerequisites": [44    "JavaScript runtime or a renderer that supports Mermaid"45  ],46  "audiences": [47    "Developers documenting systems",48    "Technical writers and educators"49  ],50  "alternatives": [51    "draw-io",52    "excalidraw",53    "figma"54  ],55  "comparison_notes": "draw.io and Excalidraw are interactive editors where you position shapes by hand; Mermaid computes layout from text, which suits version control and generated documentation. Figma is a design tool rather than a diagram generator.",56  "categories": [57    {58      "slug": "design-prototyping",59      "primary": true60    },61    {62      "slug": "documentation"63    }64  ],65  "tags": [66    "diagrams",67    "markdown",68    "javascript",69    "open-source",70    "documentation"71  ],72  "use_cases": [73    "draw-diagrams",74    "typeset-documents"75  ],76  "operating_systems": [77    "web",78    "any"79  ],80  "execution_modes": [81    "local"82  ],83  "interfaces": [84    "library",85    "cli",86    "web"87  ],88  "deployment_models": [89    "embedded"90  ],91  "integrations": [92    "GitHub",93    "GitLab",94    "Obsidian",95    "Notion",96    "Docusaurus",97    "MkDocs",98    "VS Code",99    "Excalidraw"100  ],101  "data_formats": [102    "Mermaid text",103    "SVG",104    "PNG",105    "PDF"106  ],107  "languages": [108    "JavaScript",109    "TypeScript"110  ],111  "source_model": "open-source",112  "license_spdx": "MIT",113  "pricing_model": [114    "open-source",115    "free"116  ],117  "self_hostable": true,118  "sources": [119    {120      "url": "https://mermaid.js.org/",121      "type": "official_site",122      "supports": [123        "name",124        "summary"125      ],126      "checked_at": "2026-11-02",127      "title": "Mermaid"128    },129    {130      "url": "https://mermaid.js.org/intro/",131      "type": "official_docs",132      "supports": [133        "capabilities",134        "integrations"135      ],136      "checked_at": "2026-11-02",137      "title": "Mermaid — About"138    },139    {140      "url": "https://github.com/mermaid-js/mermaid/blob/develop/LICENSE",141      "type": "license_page",142      "supports": [143        "license_spdx",144        "source_model"145      ],146      "checked_at": "2026-11-02",147      "title": "LICENSE (MIT)"148    },149    {150      "url": "https://mermaid.live/",151      "type": "official_site",152      "supports": [153        "capabilities"154      ],155      "checked_at": "2026-11-02",156      "title": "Mermaid Live Editor"157    }158  ],159  "confidence": "high",160  "depth": "standard",161  "featured": false,162  "discovery_method": "editorial-research",163  "editorial_status": "reviewed",164  "visibility": "public",165  "author": "batch-F"166}167
Files · f05ed656dfb02e05e9363ab635689d5774c375f6
Menu

Theme