Link Search Menu Expand Document

Table of contents

  1. Integrations

Mermaid JS is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. The syntax is easy and clear, and the output usually beautiful.

Mermaid Documentation Mermaid Online Editor

Integrations

About Mermaid is supported out-of-the-box by many applications, including:

  • Jetbrains IDEs (IntelliJ, etc.) through the built-in Markdown Plugin (see diagrams);
  • Visual Studio code;
  • gitlab.com renders mermaid diagrams in and md file;
  • typora;

See mermaid-js#integrations for a full list.

GitHub does not support it for now, but there are many browser extensions available that will automatically detect and render the diagrams in md files. I personally use mermaid-extension.

Enable Mermaid rendering in GitHub READMEs