mermaid-js/mermaid

Mermaid is a JavaScript library that turns short, Markdown-like text into rendered diagrams. Instead of opening a drawing tool and dragging shapes around, you write a few lines describing what you want, for example, the relationships between boxes in a flowchart, or the back-and-forth in a sequence diagram, and Mermaid converts that text into a real diagram on the page. The README describes the goal as helping documentation keep up with development: text definitions are easy to edit and version-control, so diagrams stay current as code changes. The way it works is that Mermaid parses your diagram text and uses its own renderer to draw the result, either in the browser or anywhere JavaScript runs. Because the input is plain text, you can store diagrams in code repositories, generate them from scripts, and review changes in pull requests like any other source file. The Mermaid Live Editor on the project's website lets non-programmers and beginners try out diagrams without installing anything. The README mentions topics including flowcharts, sequence diagrams, mind maps, and UML diagrams. You would use Mermaid when you want diagrams that live next to your code or your documentation, that anyone on a team can edit, and that don't require a separate drawing tool. It is widely embedded, the README links to GitHub's support for Mermaid inside Markdown files, and to a list of community integrations covering many other applications. The library is published in TypeScript, distributed on npm, and also available via a CDN for direct use in a webpage. The full README is longer than what was provided.