Mermaid

Mermaid is a text-to-diagram rendering engine that transforms markdown-inspired text definitions into visual flowcharts, sequence diagrams, and Gantt charts. It functions as a markdown-based diagramming tool designed to keep technical documentation synchronized with development by defining visuals as plain text.

The engine utilizes a sandboxed rendering process, executing diagram generation inside isolated frames to prevent malicious scripts embedded in user text from executing in the browser.

The system handles client-side text transformation and domain-specific language parsing to map text descriptions to rule-based layouts. These are rendered as scalable vector graphics directly in the browser.

Features

Text-to-Diagram Generators - Converts markdown-inspired text definitions into visual diagrams to synchronize documentation with development.
Diagramming Tools - Provides a text-based system for creating technical diagrams, flowcharts, and architectural visualizations.
Chart Generators - Generates diverse chart types including flowcharts, sequence diagrams, and Gantt charts from text definitions.
Diagramming Engines - Operates as a diagramming engine that converts markdown-inspired text definitions into visual layouts.
Iframe Sandboxing - Utilizes iframe sandboxing to prevent arbitrary script execution from user-provided diagram text.
Sandboxed Rendering - Implements a rendering engine that isolates diagram generation in secure frames to prevent script injection.
Syntax Parsing Engines - Implements a syntax parsing engine that transforms custom markdown-like text into an abstract syntax tree.
Diagram Integrations - Provides a standardized syntax for adding dynamic visual charts directly to markdown files and documentation sites.
Diagram Synchronization - Keeps architectural diagrams synchronized with code by defining visuals as text within version-controlled files.
SVG-Based Vector Rendering - Uses SVG-based vector rendering to display diagrams based on mathematical coordinates.
Client-Side Text Transformations - Performs all text-to-visual transformations directly in the browser without requiring a backend server.
Constraint-Based - Determines node and edge positions using a rule-based constraint solver.
Data Visualization - Generates flowcharts from text-based syntax.
General Purpose - Generates diagrams and flowcharts from markdown-style text.
Markup-based Diagram Tools - Tool for generating diagrams and flowcharts from markdown-like text.
Markup-based Tools - Tool for generating diagrams and flowcharts from markdown-like text.

Star history

How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.

knsvmermaid

Name: knsv/mermaid
Author: knsv

View on GitHub

88,686 stars9,049 forksTypeScriptMIT49 viewsmermaid.ai/open-source

Mermaid

The engine utilizes a sandboxed rendering process, executing diagram generation inside isolated frames to prevent malicious scripts embedded in user text from executing in the browser.

Features

Text-to-Diagram Generators - Converts markdown-inspired text definitions into visual diagrams to synchronize documentation with development.
Diagramming Tools - Provides a text-based system for creating technical diagrams, flowcharts, and architectural visualizations.
Chart Generators - Generates diverse chart types including flowcharts, sequence diagrams, and Gantt charts from text definitions.
Diagramming Engines - Operates as a diagramming engine that converts markdown-inspired text definitions into visual layouts.
Iframe Sandboxing - Utilizes iframe sandboxing to prevent arbitrary script execution from user-provided diagram text.
Sandboxed Rendering - Implements a rendering engine that isolates diagram generation in secure frames to prevent script injection.
Syntax Parsing Engines - Implements a syntax parsing engine that transforms custom markdown-like text into an abstract syntax tree.
Diagram Integrations - Provides a standardized syntax for adding dynamic visual charts directly to markdown files and documentation sites.
Diagram Synchronization - Keeps architectural diagrams synchronized with code by defining visuals as text within version-controlled files.
SVG-Based Vector Rendering - Uses SVG-based vector rendering to display diagrams based on mathematical coordinates.
Client-Side Text Transformations - Performs all text-to-visual transformations directly in the browser without requiring a backend server.
Constraint-Based - Determines node and edge positions using a rule-based constraint solver.
Data Visualization - Generates flowcharts from text-based syntax.
General Purpose - Generates diagrams and flowcharts from markdown-style text.
Markup-based Diagram Tools - Tool for generating diagrams and flowcharts from markdown-like text.
Markup-based Tools - Tool for generating diagrams and flowcharts from markdown-like text.

Projects sharing features with Mermaid

These projects share indexed features with Mermaid. Shared tags can include platform or build tooling; verify the primary use case before treating a result as a replacement.

plantuml/plantuml
plantuml/plantuml
13,093View on GitHub
PlantUML is a text-to-diagram generator that translates human-readable markup into structured graphical representations. It functions as a diagram-as-code tool, allowing users to create and maintain technical documentation, architectural models, and flowcharts by decoupling diagram content from visual layout. The project distinguishes itself through a comprehensive rendering pipeline that processes domain-specific markup into various output formats, including vector and raster graphics. It utilizes a graph-based layout engine to calculate spatial positioning, while a declarative styling layer
Javadiagramdiagram-as-codediagrams
View on GitHub13,093
asmuth/clip
asmuth/clip
5,148View on GitHub
Clip is a command-line data visualization tool designed to generate image-based charts and diagrams from text descriptions. It functions as a chart generator that converts written data and descriptive patterns into visual formats without the use of a graphical user interface. The tool specializes in producing scalable vector graphics, translating text-to-chart transformations into XML-based vector paths. This approach allows for the automated creation of technical illustrations and diagrams specifically suited for developer documentation. The system employs a template-driven layout engine to
C++chartchartscpp17
View on GitHub5,148
jgraph/drawio
jgraph/drawio
6,292View on GitHub
drawio is a web-based diagramming tool and cross-platform visual designer used for creating flowcharts, network maps, and technical schemas. It functions as a vector graphics editor and an XML-based diagramming engine that allows users to design and export scalable graphics. The software supports a wide range of technical design tasks, including infrastructure mapping for server layouts and the creation of visual aids for technical documentation. It enables the import of diagram files from other tools to facilitate cross-tool migration.
JavaScriptdiagramjavascriptwhiteboard
View on GitHub6,292
terrastruct/d2
terrastruct/d2
23,083View on GitHub
This project is a diagram-as-code tool that transforms declarative text scripts into professional visual representations. It functions as a technical documentation generator, allowing users to define nodes, connections, and hierarchical relationships through a domain-specific modeling language that integrates directly into version-controlled developer workflows. The tool distinguishes itself through a highly modular architecture that decouples diagram definitions from spatial positioning. It features a pluggable layout engine that supports multiple arrangement algorithms, alongside a styling
Godeveloper-toolsdiagrammingdiagrams
View on GitHub23,083

Compare all 30 related projects

Frequently asked questions

What does knsv/mermaid do?

What are the main features of knsv/mermaid?

The main features of knsv/mermaid are: Text-to-Diagram Generators, Diagramming Tools, Chart Generators, Diagramming Engines, Iframe Sandboxing, Sandboxed Rendering, Syntax Parsing Engines, Diagram Integrations.

Which projects share features with knsv/mermaid?

Projects with overlapping indexed features include: plantuml/plantuml — PlantUML is a text-to-diagram generator that translates human-readable markup into structured graphical… asmuth/clip — Clip is a command-line data visualization tool designed to generate image-based charts and diagrams from text… jgraph/drawio — drawio is a web-based diagramming tool and cross-platform visual designer used for creating flowcharts, network maps,… terrastruct/d2 — This project is a diagram-as-code tool that transforms declarative text scripts into professional visual… gollum/gollum — Gollum is a Git-powered wiki engine and content management system that provides a web-based interface for editing and… lecho/hellocharts-android — Hellocharts-android is a data visualization library and charting framework for Android applications. It provides a…