mermaid-js/mermaid

Mermaid is a tool that turns plain text into diagrams. You write a short description of the diagram you want, a flowchart, a sequence diagram, a mind map, a UML diagram, in a Markdown-inspired syntax, and Mermaid renders it as an image. The README describes it as a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The everyday problem is what the project calls Doc-Rot: drawing diagrams by hand in a separate tool is slow, and they fall out of sync with the code or design they describe. Doing without diagrams hurts productivity and shared understanding. Because Mermaid diagrams are just text, they sit next to the rest of a project's files, can be edited and reviewed like any other source code, and can be made part of production scripts or release pipelines. A hosted Live Editor lets non-programmers create diagrams in a browser without installing anything. You would reach for Mermaid when you want diagrams in documentation, READMEs, design notes, or presentations and want them to stay in step with the rest of the project. The README highlights that Mermaid diagrams are supported directly inside GitHub Markdown files and points to a long list of community integrations. The library is published to npm as the package mermaid, also available via a CDN, and the repository's primary language is TypeScript.