Built something? We create video reels & spotlights for GitHub projects.Promote your project →
mermaid-js
Home / TypeScript / mermaid

mermaid-js/mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

TypeScript ◇ diagrams MIT
★90.4KSTARS
⑂9.3KFORKS
!1,831ISSUES
🏆#99GLOBAL RANK
🔥6DAYS TRENDING
🚀
Maintainer Growth Kit for mermaid

Claim this project, add your verified backlink badge to your README, and download milestone cards.

Claim Repo

Star History

Continuous Observations
Interactive star growth chart for mermaid-js/mermaid
CSV

Momentum

+2.3K

STARS · LAST 30 DAYS

75

PER DAY

#25

MOST-STARRED TypeScript

Window7 days30 days90 days
Stars gained+525+2.3K+6.8K
Per day757575
Forks gained+47+186+465

mermaid gained 2.3K stars in the last 30 days, about 75 a day, and now has 90.4K. It is about 12 years old and has averaged roughly 7.5K stars a year. It ranks #25 among TypeScript repositories and #99 across all languages on GitHubRepo.

Trending Record

mermaid has maintained a continuous presence across global trending indexes, peaking at #92. Below is the 30-day activity profile:

💡 Overview

mermaid is an open-source project written in TypeScript: Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown.

Engineered for speed, consistency, and developer ease, it solves common hurdles in diagrams, diagrams-as-code, documentation. It provides clear interfaces, comprehensive configuration options, and seamless integration with existing tools across the modern development stack.

⚡ Key Features

1

Optimized execution pipeline written in TypeScript for predictable speed.

2

Zero-friction configuration with comprehensive sensible defaults out of the box.

3

Cross-platform runtime support across Linux, macOS, and Windows environments.

4

Strong typing and modular architecture designed for easy extension and maintainability.

5

Standardized CLI and API interfaces for smooth integration into CI/CD workflows.

6

Active community maintenance with regular dependency updates and security patches.

📥 Installation

terminal
$ npm install mermaid

⚙ System Requirements

Platforms

  • • macOS
  • • Linux
  • • Windows

Runtime & Dependencies

Node.js >= 18, npm, pnpm or bun

Architecture

x86_64, ARM64 (Apple Silicon & Graviton)

🧠 How It Works

mermaid coordinates its core functionality through a modular TypeScript pipeline. It parses configuration parameters, validates inputs, and resolves dependencies asynchronously. By minimizing runtime overhead and keeping allocations localized, it delivers predictable performance in both local development environments and automated production workloads.

🎯 Production Use Cases

Production System Integration

Embed mermaid into TypeScript backend services to handle core application logic.

CI/CD Automated Pipelines

Run automated validation, builds, and integration suites during deployments.

Developer Tooling & Workflows

Accelerate developer onboarding with pre-configured project utilities.

Open Source Extension

Fork and customize internal modules under the repository's open MIT license.

🚀 Getting Started

1

Install mermaid using your package manager: `npm install mermaid`

2

Initialize your project workspace or configuration file for mermaid.

3

Import mermaid into your codebase or invoke it directly from your terminal.

4

Execute your test suite or run `mermaid --help` to verify successful setup.

👍 Strengths

Active community backing with 90,411 GitHub stars and verified adoption.
Permissive open-source distribution under the MIT license.
Built in TypeScript for high execution speed and developer familiarity.
Cross-platform compatibility across modern Linux, macOS, and Windows environments.
Clean modular design allowing flexible configuration and pipeline integration.

⚠️ Considerations

Requires familiarity with TypeScript and modern CLI workflows.
Ecosystem extensions may require manual configuration depending on environment constraints.
Active development roadmap means breaking API changes may occur across major versions.

⇄ Alternatives & Direct Competitors

F
freeCodeCamp/freeCodeCamp ★ 456.3K TypeScript

freeCodeCamp.org's open-source codebase and curriculum. Learn math, programming, and computer science for free.

Compare ↗
D
deepseek-ai/deepseek-harness ★ 237.6K TypeScript

DeepSeek Harness: Everything is a Plugin.

Compare ↗
V
vuejs/vue ★ 212.8K TypeScript

This is the repo for Vue 2. For Vue 3, go to https://github.com/vuejs/core

Compare ↗
O
anomalyco/opencode ★ 210.4K TypeScript

The open source coding agent.

Compare ↗

👥 Who Should Use This

Developers and engineering teams building with TypeScript, seeking reliable, tested, and actively maintained tooling for production workloads.

🏆 Nearby in the Rankings

mermaid-js/mermaid is currently ranked #99 by stars across every repository tracked on GitHubRepo. These are adjacent projects:

RankRepositoryLanguageStarsAction
#94 infiniflow/ragflow Go ★ 91.4K Compare ↗
#95 django/django Python ★ 91.2K Compare ↗
#96 home-assistant/core Python ★ 91.2K Compare ↗
#97 storybookjs/storybook TypeScript ★ 91.2K Compare ↗
#98 OpenCut-app/OpenCut TypeScript ★ 90.8K Compare ↗
#99 mermaid-js/mermaid This Project TypeScript ★ 90.4K
#100 Leonxlnx/taste-skill JavaScript ★ 90.4K Compare ↗
#101 PaddlePaddle/PaddleOCR Python ★ 90.3K Compare ↗
#102 bitcoin/bitcoin C++ ★ 90.3K Compare ↗
#103 astral-sh/uv Rust ★ 90.2K Compare ↗
#104 gohugoio/hugo Go ★ 90K Compare ↗

Frequently Asked Questions

What does mermaid do? +

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

What language is mermaid written in? +

The primary language is TypeScript. Topics include: diagrams, diagrams-as-code, documentation, flowchart, javascript.

Is mermaid actively maintained? +

Yes, the last recorded push was on Sep 21, 2026 with 1,831 open issues being tracked.

How many stars does mermaid have? +

mermaid has 90,447 stars and 9,305 forks on GitHub.

How does mermaid rank among GitHub repositories? +

With 90,447 stars, mermaid-js/mermaid is ranked #99 globally across all repositories tracked on GitHubRepo and #25 among TypeScript projects.

What license is mermaid distributed under? +

The repository reports a MIT license. Always verify the repository LICENSE file for legal terms.

From our network
FOR MAINTAINERS

Built something? Put it in front of millions of developers.

We make a short reel about your project and post it across YouTube, Instagram, Threads, and X. Send a link, we do the rest.