Mermaid (software)

Last updated
Mermaid
Developer(s) Knut Sveidqvist and contributors
Initial release2014
Repository github.com/mermaid-js/mermaid
Written inJavaScript
Operating system Cross-platform
Type Diagramming and charting
License MIT
Website mermaid.js.org

Mermaid is an open-source JavaScript-based diagramming and charting tool that generates diagrams from text-based descriptions. [1] Created by Knut Sveidqvist in 2014, the project originated from a need to simplify diagram creation in documentation workflows after experiencing issues with proprietary software file formats. [2] [3]

Contents


Features

Mermaid allows users to create various types of diagrams using a Markdown-like syntax, including: [4]

The software provides both text-based and visual editing interfaces, allowing users to switch between the two modes. [2] Users can create diagrams through the Mermaid Live Editor, a web-based tool that provides real-time preview capabilities without requiring local installation. [5]

Integration

Mermaid is supported natively by several platforms and services: [6] [7]

Development

As of 2024, the project is developed under both open-source and commercial models. The core functionality remains open-source under the MIT License, while a commercial offering called Mermaid Chart provides additional features and hosted services. [2] The open-source project has garnered significant community engagement, with over 74,000 GitHub stars and 6,800 forks as of early 2025. [1]

In March 2024, the commercial entity raised $7.5 million in seed funding from investors including Open Core Ventures, Sequoia, and Microsoft's M12 fund. [2]

Recognition

The project received the JS Open Source Award in 2019 for "The Most Exciting Use of Technology." [18]

See also

Related Research Articles

The following tables compare general and technical information for many wiki software packages.

A source-code-hosting facility is a file archive and web hosting facility for source code of software, documentation, web pages, and other works, accessible either publicly or privately. They are often used by open-source software projects and other multi-developer projects to maintain revision and version history, or version control. Many repositories provide a bug tracking system, and offer release management, mailing lists, and wiki-based project documentation. Software authors generally retain their copyright when software is posted to a code hosting facilities.

<span class="mw-page-title-main">Markdown</span> Plain text markup language

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber created Markdown in 2004 as an easy-to-read markup language. Markdown is widely used for blogging and instant messaging, and also used elsewhere in online forums, collaborative software, documentation pages, and readme files.

diagrams.net Web based diagram editor

diagrams.net is a cross-platform graph drawing software application developed in HTML5 and JavaScript. Its interface can be used to create diagrams such as flowcharts, wireframes, UML diagrams, organizational charts, and network diagrams.

Azure DevOps Server, formerly known as Team Foundation Server (TFS) and Visual Studio Team System (VSTS), is a Microsoft product that provides version control, reporting, requirements management, project management, automated builds, testing and release management capabilities. It covers the entire application lifecycle and enables DevOps capabilities. Azure DevOps can be used as a back-end to numerous integrated development environments (IDEs) but is tailored for Microsoft Visual Studio and Eclipse on all platforms.

Bitbucket is a Git-based source code repository hosting service owned by Atlassian. Bitbucket offers both commercial plans and free accounts with an unlimited number of private repositories.

<span class="mw-page-title-main">Cloud9 IDE</span> Online integrated development environment

Cloud9 IDE is an Online IDE, published as open source from version 2.0, until version 3.0. It supports multiple programming languages, including C, C++, PHP, Ruby, Perl, Python, JavaScript with Node.js, and Go.

<span class="mw-page-title-main">RStudio</span> Integrated development environment for R

RStudio IDE is an integrated development environment for R, a programming language for statistical computing and graphics. It is available in two formats: RStudio Desktop is a regular desktop application while RStudio Server runs on a remote server and allows accessing RStudio using a web browser. The RStudio IDE is a product of Posit PBC.

Pandoc is a free-software document converter, widely used as a writing tool and as a basis for publishing workflows. It was created by John MacFarlane, a philosophy professor at the University of California, Berkeley.

<span class="mw-page-title-main">PlantUML</span> Open-source software visualization tool

PlantUML is an open-source tool allowing users to create diagrams from a plain text language. Besides various UML diagrams, PlantUML has support for various other software development related formats, as well as visualisation of JSON and YAML files.

GitLab Inc. is a company that operates and develops GitLab, an open-core DevOps software package that can develop, secure, and operate software. GitLab includes a distributed version control system based on Git, including features such as access control, bug tracking, software feature requests, task management, and wikis for every project, as well as snippets.

<span class="mw-page-title-main">Joseph J. Allaire</span> American software engineer and entrepreneur

Joseph J. Allaire, better known professionally as J. J. Allaire, is an American-born software engineer and Internet entrepreneur. He created the ColdFusion programming language and web application server, founded Allaire Corporation, OnFolio, FitNow, and RStudio, and created LoseIt! and Windows Live Writer. Allaire is currently the founder and CEO of statistical computing company Posit.

Terraform is an infrastructure-as-code software tool created by HashiCorp. Users define and provide data center infrastructure using a declarative configuration language known as HashiCorp Configuration Language (HCL), or optionally JSON.

<span class="mw-page-title-main">Project Jupyter</span> Open source data science software

Project Jupyter is a project to develop open-source software, open standards, and services for interactive computing across multiple programming languages.

<span class="mw-page-title-main">Katalon Studio</span> Automation testing software tool

Katalon Platform is an automation testing software tool developed by Katalon, Inc. The software is built on top of the open-source automation frameworks Selenium, Appium with a specialized IDE interface for web, API, mobile and desktop application testing. Its initial release for internal use was in January 2015. Its first public release was in September 2016. In 2018, the software acquired 9% of market penetration for UI test automation, according to The State of Testing 2018 Report by SmartBear.

<span class="mw-page-title-main">Gitea</span> Free forge based on Git written in Go

Gitea is a forge software package for hosting software development version control using Git as well as other collaborative features like bug tracking, code review, continuous integration, kanban boards, tickets, and wikis. It supports self-hosting but also provides a free public first-party instance. It is a fork of Gogs and is written in Go. Gitea can be hosted on all platforms supported by Go including Linux, macOS, and Windows. The project is funded on Open Collective.

<span class="mw-page-title-main">Obsidian (software)</span> Knowledge base and note-taking software

Obsidian is a personal knowledge base and note-taking software application that operates on Markdown files. It allows users to make internal links for notes and then to visualize the connections as a graph. It is designed to help users organize and structure their thoughts and knowledge in a flexible, non-linear way. The software is free for personal use, with paid commercial licenses available.

References

  1. 1 2 "Mermaid GitHub Repository". GitHub .
  2. 1 2 3 4 Frederic Lardinois (March 20, 2024). "Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M". TechCrunch.
  3. ↑ Amit Chowdhry (Aug 26, 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0.
  4. ↑ Kerry Doyle (December 12, 2023). "A review of software architecture visualization tools". TechTarget.
  5. ↑ "Mermaid Live Editor".
  6. ↑ Justin Pot (November 13, 2024). "Use Mermaid to Create Charts and Diagrams Without Image Editing Tools". LifeHacker.
  7. ↑ "Mermaid Integrations".
  8. ↑ "Markdown Guidance for Wikis – Azure DevOps". 6 September 2024.
  9. ↑ "Include diagrams in Markdown files with Mermaid on GitHub". 14 February 2022.
  10. ↑ Ian Elliot (February 15, 2022). "GitHub Supports Mermaid For Creating Diagrams". I Programmer.
  11. ↑ "Gitea - Compared to other Git hosting".
  12. ↑ "Gitlab Handbook".
  13. ↑ "Joplin - Markdown Guide".
  14. ↑ "Tuleap 12.7".
  15. ↑ "Notion – Release Notes 2021-12-23".
  16. ↑ "Obsidian Changelog 0.7.6".
  17. ↑ "Quarto – Diagram Authoring".
  18. ↑ ""Mermaid" – Notes by NicFab". 22 March 2022.
This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.