Quick Start: This guide gets you writing Mermaid diagrams that render on GitHub in about 15 minutes. Learn the two diagram types that cover most real work, then build a deployment pipeline diagram you can drop into any README. What You’ll Learn What is Mermaid, and what problem does it solve? What are the use cases for Mermaid? When is Mermaid not the right tool? Which two diagram types cover most real work? How do you build a pipeline diagram and publish it on GitHub? Where can you go to learn more about Mermaid? The Basics Mermaid is an open-source tool that turns short text descriptions into diagrams. Type A --> B and you get two boxes connected by an arrow. Knut Sveidqvist created it in 2014 so diagrams could live where code lives: in plain text, in version control, reviewed in pull requests like everything else.