# Mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

Repository: https://github.com/mermaid-js/mermaid
Canonical: https://ross.abutalabs.com/products/mermaid
Homepage: https://mermaid.ai/open-source/
Language: TypeScript
License: MIT
License Family: permissive
Topics: documentation, flowchart, javascript, typescript, uml-diagrams, diagrams, diagrams-as-code, mindmap
Last push: 2026-08-26T21:39:08+00:00

## Health v2 (maintenance only)
Score: 95/100 (v2, computed 2026-09-03T02:39:23.370411+00:00)
- activity 99, release rhythm 87, longevity 100
- inputs: {"age_days": 4323, "days_push": 7, "days_rel": 8, "gap_med": 0, "n_releases_24m": 80}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 89955, forks 9187 (observed 2026-08-28T04:12:23.233822+00:00)

## What it is
Mermaid is a JavaScript library that generates diagrams such as flowcharts, sequence diagrams, and mindmaps from markdown-like text definitions. It includes a live editor and a CLI for rendering diagrams, and integrates widely with documentation tools.

## Use cases
- render flowcharts from text in markdown docs
- draw sequence diagrams as code
- embed diagrams in README files on GitHub
- generate architecture diagrams from plain text
- create mindmaps and gantt charts from text
- convert diagram definitions to SVG via CLI

## When to choose
- you want diagrams-as-code that live in version control
- you need diagrams inside markdown documentation or wikis
- you want a text-based alternative to diagramming GUIs

## When to avoid
- you need pixel-perfect visual design control of diagrams
- you need complex free-form drawing or CAD-like editing
- you need offline rendering without JavaScript or a browser/node environment

## Facets
- artifact type: library
- maturity: stable
- function: data-visualization, documentation, parser, templating
- domain: developer-tools, documentation, data-visualization, web-development
- platform: browser, cross-platform, cli
- tags: diagrams-as-code, flowchart, sequence-diagram, uml, markdown, mermaid, nodejs

## Member repositories
- mermaid-js/mermaid (main) score 95
- mermaid-js/mermaid-live-editor (frontend) score 77
- mermaid-js/mermaid-cli (plugin) score 96

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:12:23.233822+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T16:13:51.839904+00:00, confidence not recorded.
  - readme: https://github.com/mermaid-js/mermaid (fetched 2026-08-28T04:12:23.233822+00:00, sha cf5be641aa9f)
- Data as of 2026-08-30T08:39:29.467469+00:00.