mermaid Documentation

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

89,717 stars TypeScript TypeScript 1 file · ~15,389 tokens #diagrams#diagrams-as-code#documentation#flowchart#javascript#mindmap#typescript#uml-diagrams
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy mermaid on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name mermaid -p 3333:3333 --restart always mermaid-js/mermaid:latest
Configured Services & Ports
⚙️ mermaid
image: build locally
🔌 Ports: ${MERMAID_PORT}:${MERMAID_PORT}, 3333:3333
docker-compose.yml
yaml (docker-compose.yml) 
services:
  mermaid:
    build:
      context: .
      dockerfile: Dockerfile
    stdin_open: true
    tty: true
    working_dir: /mermaid
    mem_limit: '8G'
    env_file:
      - .env
    volumes:
      - ./:/mermaid
      - root_cache:/root/.cache
      - root_local:/root/.local
      - root_npm:/root/.npm
      - /tmp:/tmp
    ports:
      - ${MERMAID_PORT}:${MERMAID_PORT}
      - 3333:3333

volumes:
  root_cache:
  root_local:
  root_npm:

File: README.md

Mermaid










:trophy: Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!!

Thanks to all involved, people committing pull requests, people answering questions! 🙏

Table of content

Expand contents

About

Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development.

Doc-Rot is a Catch-22 that Mermaid helps to solve.

Diagramming and documentation costs precious developer time and gets outdated quickly.
But not having diagrams or docs ruins productivity and hurts organizational learning.
Mermaid addresses this problem by enabling users to create easily modifiable diagrams. It can also be made part of production scripts (and other pieces of code).

Mermaid allows even non-programmers to easily create detailed diagrams through the Mermaid Live Editor.
For video tutorials, visit our Tutorials page.
Use Mermaid with your favorite applications, check out the list of Integrations and Usages of Mermaid.

You can also use Mermaid within GitHub as well many of your other favorite applications—check out the list of Integrations and Usages of Mermaid.

For a more detailed introduction to Mermaid and some of its more basic uses, look to the Beginner's Guide, Usage and Tutorials.

Our PR Visual Regression Testing is powered by Argos with their generous Open Source plan. It makes the process of reviewing PRs with visual changes a breeze.

In our release process we rely heavily on visual regression tests using applitools. Applitools is a great service which has been easy to use and integrate with our tests.

Features

  • 20+ Diagram Types – Flowchart, Sequence, Class, State, ER, Gantt, Pie, Git Graph, Mindmap, Timeline, Sankey, and more
  • Markdown-Inspired Syntax – Write diagrams as text, no drag-and-drop required
  • No Design Tool Needed – Generate professional diagrams straight from code
  • Live Editor – Prototype instantly at mermaid.live
  • Version-Control Friendly – Diagrams live as text, so diffs and reviews just work
  • Native GitHub Rendering – Mermaid code blocks render directly in Markdown on GitHub
  • Highly Customizable – Themes, colors, fonts, and layout directions
  • Security First – Built-in sanitization plus a sandboxed rendering mode
  • Lightweight – Small footprint, no heavy dependencies
  • Active Community – Frequent releases and thousands of contributors
  • Open Source – MIT licensed

Examples

The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here to jump into the text syntax.

Flowchart [[docs](https://mermaid.js.org/syntax/flowchart.html) - [live editor](https://mermaid.live/edit#pako:eNpNkMtqwzAQRX9FzKqFJK7t1km8KDQP6KJQSLOLvZhIY1tgS0GWmgbb_165IaFaiXvOFTPqgGtBkEJR6zOv0Fj2scsU8-ft8I5G5Gw6fe339GN7tnrYaafE45WvRsLW3Ya4bKVWwzVe_xU-FfVsc9hR62rLwvw_2591z7Y3FuUwgYZMg1L4ObrRzMBW1FAGqb8KKtCLGWRq8Ko7CbS0FdJqA2mBdUsTQGf110VxSK1xdJM2EkuDzd2qNQrypQ7s5TQuXcrW-ie5VoUsx9yZ2seVtac2DYIRz0ppK3eccd0ErRTjD1XfyyRIomSBUUzJPMaXOBb8GC4XRfQcFmL-FEYIwzD8AggvcHE)]

text
flowchart LR

A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
mermaid
flowchart LR

A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]

Sequence diagram [[docs](https://mermaid.js.org/syntax/sequenceDiagram.html) - [live editor](https://mermaid.live/edit#pako:eNo9kMluwjAQhl_F-AykQMuSA1WrbuLQQ3v1ZbAnsVXHkzrjVhHi3etQwKfRv4w-z0FqMihL2eF3wqDxyUEdoVHhwTuNk-12RzaU4g29JzHMY2HpV0BE0VO6V8ETtdkGz1Zb1F8qiPyG5LX84mrLAmpwoWNh-5a0pWCiAxUwGBXeiVHEU4oq8V_6AHYUwAu2lLLTjVQ4bc1rT2yleI0IfJG320faZ9ABbk-Jz3hZnFxBduR9L2oiM5Jj2WBswJn8-cMArSRbbFDJMo8GK0ielVThmKOpNcD4bBxTlGUFvsOxhMT02QctS44JL6HzAS-iJzCYOwfJfTscunYd542aQuXqQU_RZ9kyt11ZFIM9rR3btJ9qaorOGQuR7c9mWSznyzXMF7hcLeBusTB6P9usq_ntrDKrm9kc5PF4_AMJE56Z)]

text
sequenceDiagram
Alice->>John: Hello John, how are you?
loop HealthCheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
loop HealthCheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!

Gantt chart [[docs](https://mermaid.js.org/syntax/gantt.html) - [live editor](https://mermaid.live/edit#pako:eNp90cGOgyAQBuBXIZxtFbG29bbZ3fsmvXKZylhJEAyOTZrGd1_sto3xsHMBhu-HBO689hp5xS_giJQbsCbjHTv9jcp9-q63SKhZpb3DhMXSOIiE5ZkoNpnYZGXynh6U-4jBK7JnVfBYJo9QvgjtEya1cj8QwFq0TMz4lZqxTBg0hOF5m1jifI2Lf7Bc490CyxUu1rhc4GLGPOEdhg6Mjq92V44xxanFDhWv4lRjA6MlxZWbIh17DYTf2pAPvGrADphwGMmfbq7mFYURX-jLwCVA91bWg8YYunO69Y8vMgPFI2vvGnOZ-2Owsd0S9UOVpvP29mKoHc_b2nfpYHQLgdrrsUzLvDxALrHcS9hJqeuzOB6avBCN3mciBz5N0y_wxZ0J)]

text
gantt
    section Section
    Completed :done,    des1, 2014-01-06,2014-01-08
    Active        :active,  des2, 2014-01-07, 3d
    Parallel 1   :         des3, after des1, 1d
    Parallel 2   :         des4, after des1, 1d
    Parallel 3   :         des5, after des3, 1d
    Parallel 4   :         des6, after des4, 1d
mermaid
gantt
    section Section
    Completed :done,    des1, 2014-01-06,2014-01-08
    Active        :active,  des2, 2014-01-07, 3d
    Parallel 1   :         des3, after des1, 1d
    Parallel 2   :         des4, after des1, 1d
    Parallel 3   :         des5, after des3, 1d
    Parallel 4   :         des6, after des4, 1d

Class diagram [[docs](https://mermaid.js.org/syntax/classDiagram.html) - [live editor](https://mermaid.live/edit#pako:eNpdkTFPwzAQhf-K5QlQ2zQJJG1UBaGWDYmBgYEwXO1LYuTEwXYqlZL_jt02asXm--690zvfgTLFkWaUSTBmI6DS0BTt2lfzkKx-p1PytEO9f1FtdaQkI2ulZNGuVqK1qEtgmOfk7BitSzKdOhg59XuNGgk0RDxed-_IOr6uf8cZ6UhTZ8bvHqS5ub1mr9svZPbjk6DEBlu7AQuXyBkx4gcvDk9cUMJq0XT_YaW0kNK5j-ufAoRzcihaQvLcoN4Jv50vvVxw_xrnD3RCG9QNCO4-8OgpqK1dpoJm7smxhF7agp6kfcfB4jMXVmmalW4tnFDorXrbt4xmVvc4is53GKFUwNF5DtTuO3-sShjrJjLVlqLyvNfS4drazmRB4NuzSti6386YagIjeA3a1rtlEiRRsoAoxiSN4SGOOduGy0UZ3YclT-dhBHQYhj8dc6_I)]

text
classDiagram
Class01 <|-- AveryLongClass : Cool
<> Class01
Class09 --> C2 : Where am I?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
class Class10 {
  <<service>>
  int id
  size()
}
mermaid
classDiagram
Class01 <|-- AveryLongClass : Cool
<> Class01
Class09 --> C2 : Where am I?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
class Class10 {
  <<service>>
  int id
  size()
}

State diagram [[docs](https://mermaid.js.org/syntax/stateDiagram.html) - [live editor](https://mermaid.live/edit#pako:eNpdkEFvgzAMhf8K8nEqpYSNthx22Xbcqcexg0sCiZQQlDhIFeK_L8A6TfXp6fOz9ewJGssFVOAJSbwr7ByadGR1n8T6evpO0vQ1uZDSekOrXGFsPqJPO6q-2-imH8f_0TeHXm50lfelsAMjnEHFY6xpMdRAUhhRQxUlFy0GTTXU_RytYeAx-AdXZB1ULWovdoCB7OXWN1CRC-Ju-r3uz6UtchGHJqDbsPygU57iysb2reoWHpyOWBINvsqypb3vFMlw3TfWZF5xiY7keC6zkpUnZIUojwW-FAVvrvn51LLnvOXHQ84Q5nn-AVtLcwk)]

text
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
mermaid
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]

Pie chart [[docs](https://mermaid.js.org/syntax/pie.html) - [live editor](https://mermaid.live/edit#pako:eNo9jsFugzAMhl8F-VzBgEEh13Uv0F1zcYkTIpEEBadShXj3BU3dzf_n77e8wxQUgYDVkvQSbsFsEgpRtEN_5i_kvzx05XiC-xvUHVzAUXRoVe7v0heFBJ7JkQSRR0Ua08ISpD-ymlaFTN_KcoggNC4bXQATh5-Xn0BwTPSWbhZNRPdvLQEV5dIO_FrPZ43dOJ-cgtfWnDzFJeOZed1EVZ3r0lie06Ocgqs2q2aMPD_HvuqbfsCmpf7aYte2anrU46Cbz1qr60fdIBzH8QvW9lkl)]

text
pie
"Dogs" : 386
"Cats" : 85.9
"Rats" : 15
mermaid
pie
"Dogs" : 386
"Cats" : 85.9
"Rats" : 15

Git graph [experimental - [live editor](https://mermaid.live/edit#pako:eNqNkMFugzAMhl8F-VyVAR1tOW_aA-zKxSSGRCMJCk6lCvHuNZPKZdM0n-zf3_8r8QIqaIIGMqnB8kfEybQ--y4VnLP8-9RF9Mpkmm40hmlnDKmvkPiH_kfS7nFo_VN0FAf6XwocQGgxa_nGsm1bYEOOWmik1dRjGrmF1q-Cpkkj07u2HCI0PY4zHQATh8-7V9BwTPSE3iwOEd1OjQE1iWkBvk_bzQY7s0Sq4Hs7bHqKo8iGeZqbPN_WR7mpSd1RHpvPVhuMbG7XOq_L-oJlRfW5wteq0qorrpe-PBW9Pr8UJcK6rg-BLYPQ)]

text
gitGraph
  commit
  commit
  branch develop
  checkout develop
  commit
  commit
  checkout main
  merge develop
  commit
  commit
mermaid
gitGraph
  commit
  commit
  branch develop
  checkout develop
  commit
  commit
  checkout main
  merge develop
  commit
  commit

Bar chart (using gantt chart) [[docs](https://mermaid.js.org/syntax/gantt.html) - [live editor](https://mermaid.live/edit#pako:eNptkU1vhCAQhv8KIenNugiI4rkf6bmXpvEyFVxJFDYyNt1u9r8X63Z7WQ9m5pknLzieaBeMpQ3dg0dsPUkPOhwteXZIXmJcbCT3xMAxkuh8Z8kIEclyMIB209fqKcwTICFvG4IvFy_oLrZ-g9F26ILfQgvNFN94VaRXQ1iWqpumZBcu1J8p1E1TXDx59eQNr5LyEqjJn6hv5QnGNlxevZJmdLLpy5xJSzut45biYCfb0iaVxvawjNjS1p-TCguG16PvaIPzYjO67e3BwX6GiTY9jPFKH43DMF_hGMDY1J4oHg-_f8hFTJFd8L3br3yZx4QHxENsdrt1nO8dDstH3oVpF50ZYMbhU6ud4qoGLqyqBJRCmO6j0HXPZdGbihUc6Pmc0QP49xD-b5X69ZQv2gjO81IwzWqhC1lKrjJ6pA3nVS7SMiVjrKirWlYp5fs3osgrWeo00lorLWvOzz8JVbXm)]

text
gantt
    title Git Issues - days since last update
    dateFormat  X
    axisFormat %s

    section Issue19062
    71   : 0, 71
    section Issue19401
    36   : 0, 36
    section Issue193
    34   : 0, 34
    section Issue7441
    9    : 0, 9
    section Issue1300
    5    : 0, 5
mermaid
gantt
    title Git Issues - days since last update
    dateFormat  X
    axisFormat %s

    section Issue19062
    71   : 0, 71
    section Issue19401
    36   : 0, 36
    section Issue193
    34   : 0, 34
    section Issue7441
    9    : 0, 9
    section Issue1300
    5    : 0, 5

User Journey diagram [[docs](https://mermaid.js.org/syntax/userJourney.html) - [live editor](https://mermaid.live/edit#pako:eNplkMFuwjAQRH9l5TMiTVIC-FqqnjhxzWWJN4khsSN7XRSh_HsdKBVt97R6Mzsj-yoqq0hIAXCywRkaSwNxWHNHsB_hYt1ZmwYUfiueKtbWwIcFtjf5zgH2eCZgQgkrCXt64GgMg2fUzkvIn5Xd_V5COtMFvCH_62ht_5yk7MU8sn61HDTfxD8VYiF6cj1qFd94nWkpuKWYKWRcFdUYOi5FaaZoDYNCpnel2Toha-w8LQQGtofRVEKyC_Qw7TQ2DvsfV2dRUTy6Ch6H-UMb7TlGVtbUupl5cF3ELfPgZZLM8rLR3IbjsrJ94rVq0XH7uS2SIis2mOVUrHNc5bmqjul2U2evaa3WL2mGYpqmL2BGiho)]

text
journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 3: Me
mermaid
journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 3: Me

C4 diagram [[docs](https://mermaid.js.org/syntax/c4.html)]

text
C4Context
title System Context diagram for Internet Banking System

Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
Person(customerB, "Banking Customer B")
Person_Ext(customerC, "Banking Customer C")
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")

Person(customerD, "Banking Customer D", "A customer of the bank,  with personal bank accounts.")

Enterprise_Boundary(b1, "BankBoundary") {

  SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")

  System_Boundary(b2, "BankBoundary2") {
    System(SystemA, "Banking System A")
    System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts.")
  }

  System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
  SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")

  Boundary(b3, "BankBoundary3", "boundary") {
    SystemQueue(SystemF, "Banking System F Queue", "A system of the bank, with personal bank accounts.")
    SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
  }
}

BiRel(customerA, SystemAA, "Uses")
BiRel(SystemAA, SystemE, "Uses")
Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
Rel(SystemC, customerA, "Sends e-mails to")
mermaid
C4Context
title System Context diagram for Internet Banking System

Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
Person(customerB, "Banking Customer B")
Person_Ext(customerC, "Banking Customer C")
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")

Person(customerD, "Banking Customer D", "A customer of the bank,  with personal bank accounts.")

Enterprise_Boundary(b1, "BankBoundary") {

  SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")

  System_Boundary(b2, "BankBoundary2") {
    System(SystemA, "Banking System A")
    System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts.")
  }

  System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
  SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")

  Boundary(b3, "BankBoundary3", "boundary") {
    SystemQueue(SystemF, "Banking System F Queue", "A system of the bank, with personal bank accounts.")
    SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
  }
}

BiRel(customerA, SystemAA, "Uses")
BiRel(SystemAA, SystemE, "Uses")
Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
Rel(SystemC, customerA, "Sends e-mails to")

Release

For those who have the permission to do so:

Update version number in package.json.

sh
npm publish

The above command generates files into the dist folder and publishes them to https://www.npmjs.com.

Contributors [](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [](https://github.com/mermaid-js/mermaid/graphs/contributors) [](https://github.com/mermaid-js/mermaid/graphs/contributors)

Mermaid is a growing community and is always accepting new contributors. There's a lot of different ways to help out and we're always looking for extra hands! Look at this issue if you want to know where to start helping out.

Detailed information about how to contribute can be found in the contribution guide

Security and safe diagrams

For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitize the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes.

As an extra level of security for sites with external users we are happy to introduce a new security level in which the diagram is rendered in a sandboxed iframe preventing javascript in the code from being executed. This is a great step forward for better security.

Unfortunately you cannot have a cake and eat it at the same time which in this case means that some of the interactive functionality gets blocked along with the possible malicious code.

Reporting vulnerabilities

To report a vulnerability, please e-mail [email protected] with a description of the issue, the steps you took to create the issue, affected versions, and if known, mitigations for the issue.

Appreciation

A quick note from Knut Sveidqvist:

Many thanks to the d3 and dagre-d3 projects for providing the graphical layout and drawing libraries!

Thanks also to the js-sequence-diagram project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering.

Thank you to Tyler Long who has been a collaborator since April 2017.

Thank you to the ever-growing list of contributors that brought the project this far!

Mermaid was created by Knut Sveidqvist for easier documentation.

File: docs/community/contributing.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/community/contributing.md](../../packages/mermaid/src/docs/community/contributing.md).

Mermaid Contributing Guide

You decided to take part in the development? Welcome!

We are trying to make our guidelines for you as explicit and detailed as possible.

Initial Setup

Initial setup consists of 3 main steps:

mermaid
flowchart LR
  source --> requirements --> setup

  source[Get the Source Code]
  requirements[Install the Requirements]
  setup[Install Packages]

Get the Source Code

In GitHub, you first fork a mermaid repository when you are going to make changes and submit pull requests.

Then you clone a copy to your local development machine (e.g. where you code) to make a copy with all the files to work with.

💡 Tip
Here is a GitHub document that gives an overview of the process.

bash
git clone [email protected]/your-fork/mermaid

Once you have cloned the repository onto your development machine, change into the mermaid project folder (the top level directory of the mermaid project repository)

bash
cd mermaid

Install Requirements

We support development within Docker environment along with host setup. You may choose it up to your preferences.

Host

These are the tools we use for working with the code and documentation:

The following commands must be sufficient enough to start with:

bash
curl -fsSL https://get.pnpm.io/install.sh | sh -
pnpm env use --global 20

You may also need to reload .shrc or .bashrc afterwards.

Docker

Install Docker. And that is pretty much all you need.

Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
You might already have it installed, so check this by running:

bash
echo $DISPLAY

If the $DISPLAY variable is not empty, then an X11 server is running. Otherwise you may need to install one.

Install Packages

Host

Install packages:

bash
pnpm install

Docker

For development using Docker there is a self-documented run bash script, which provides convenient aliases for docker compose commands.

Make sure that ./run script is executable:

bash
chmod +x run

💡 Tip
To get detailed help simply type ./run or ./run help.

It also has short Development quick start guide embedded.

Then install packages:

bash
./run pnpm install

Verify Everything Works

This step is optional, but it helps to make sure that everything in development branch was OK before you started making any changes.

You can run the test script to verify that pnpm is working and that the repository has been cloned correctly:

Host

bash
pnpm test

Docker

bash
./run pnpm test

The test script and others are in the top-level package.json file.

All tests should run successfully without any errors or failures.

Note
You might see lint or formatting warnings. Those are ok during this step.

Workflow

Contributing process is very simple and straightforward:

mermaid
flowchart LR

  branch --> changes --> submit
  branch[Checkout a New Branch]
  changes[Make Changes]
  submit[Submit a PR]

Mermaid uses a Git Flow–inspired approach to branching.

Development is done in the develop branch.

mermaid
---
config:
  gitGraph:
    mainBranchName: develop
---
gitGraph LR:
  commit
  commit
  branch "docs/2910_update-guidelines" order: 1
  commit
  commit
  commit
  checkout develop
  merge "docs/2910_update-guidelines"
  commit

To prepare a new version for release the maintainers create a release/vX.X.X branch from develop for testing. Once the release happens we add a tag to the release branch and merge it with master. The live product and on-line documentation are what is in the master branch.

Checkout a New Branch

💡 Tip
All new work should be based on the develop branch.

Make sure you have the most up-to-date version of the develop branch.

Check out the develop branch, then fetch or pull to update it:

bash
git checkout develop
git fetch # or `git pull`

Create a new branch for your work:

bash
git checkout -b docs/2910_update-contributing-guidelines

We use the following naming convention for branches:

txt
[feature | bug | chore | docs]/[issue number]_[short-description]

You can always check current configuration of labelling and branch prefixes

  • The first part is the type of change: a feature, bug, chore, docs
  • followed by a slash (/),which helps to group like types together in many git tools
  • followed by the issue number, e.g. 2910
  • followed by an underscore (_)
  • followed by a short description with dashes (-) or underscores (_) instead of spaces
mermaid
flowchart LR
  feature --> slash
  bug --> slash
  chore --> slash
  docs --> slash
  slash --> 2945 --> underscore
  slash --> 1123 --> underscore
  underscore --> short_description_1
  underscore --> short_description_2

  underscore["_"]
  slash["/"]

  short_description_1["state-diagram-new-arrow-florbs"]
  short_description_2["fix_random_ugly_red_text"]

If your work is specific to a single diagram type, it is a good idea to put the diagram type at the start of the description. This will help us keep release notes organized by a diagram type.

Note
A new feature described in issue 2945 that adds a new arrow type called 'florbs' to state diagrams

feature/2945_state-diagram-new-arrow-florbs

💡 Tip
A bug described in issue 1123 that causes random ugly red text in multiple diagram types

bug/1123_fix_random_ugly_red_text

Contributing Code

Code is the heart of every software project. We strive to make it better. Who if not us?

Where is the Code Located?

The core of Mermaid is located under packages/mermaid/src.

Building Mermaid Locally

Host

bash
pnpm run build

Docker

bash
./run build

This will build the Mermaid library and the documentation site.

Running Mermaid Locally

Host

bash
pnpm run dev

Docker

bash
./run dev

After starting the dev server open http://localhost:9000 in your browser.

Now you are ready to make your changes!

Note: By default, the Mermaid service will run on port 9000. To use a different port, change the environment variable MERMAID_PORT in the file .env. You should only need to do this if you are using port 9000 to run other projects.

Make Changes

Have a look at http://localhost:9000. There is a list of demos that can be used to see and test your changes.

If you need a specific diagram, you can duplicate the example.html file in /demos/dev and add your own mermaid code to your copy.

That will be served at http://localhost:9000/dev/your-file-name.html.
After making code changes, the dev server will rebuild the mermaid library and automatically reload the page.

Edit files in packages/mermaid/src as required.

Write Tests

Tests ensure that each function, module, or part of code does what it says it will do. This is critically important when other changes are made to ensure that existing code is not broken (no regression).

Just as important, the tests act as specifications: they specify what the code does (or should do).
Whenever someone is new to a section of code, they should be able to read the tests to get a thorough understanding of what it does and why.

If you are fixing a bug, you should add tests to ensure that your code has actually fixed the bug, to specify/describe what the code is doing, and to ensure the bug doesn't happen again.
(If there had been a test for the situation, the bug never would have happened in the first place.)
You may need to change existing tests if they were inaccurate.

If you are adding a feature, you will definitely need to add tests. Depending on the size of your feature, you may need to add integration tests.

Unit Tests

Unit tests are tests that test a single function or module. They are the easiest to write and the fastest to run.

Unit tests are mandatory for all code except the layout tests. (The layouts are tested with integration tests.)

We use Vitest to run unit tests.

Host

You can use the following command to run the unit tests:

sh
pnpm test

When writing new tests, it's easier to have the tests automatically run as you make changes. You can do this by running the following command:

sh
pnpm test:watch

Docker

When using Docker prepend your command with ./run:

sh
./run pnpm test

Testing the DOM

One can use jsdomIt to test any part of Mermaid that interacts with the DOM, as long as it is not related to the layout.

The function jsdomIt (developed in utils.ts) overrides it from vitest, and creates a pseudo-browser environment that works almost like the real deal for the duration of the test. It uses JSDOM to create a DOM, and adds objects window and document to global to mock the browser environment.

[!NOTE]
The layout cannot work in jsdomIt tests because JSDOM has no rendering engine, hence the pseudo-browser environment.

Example :

typescript
import { ensureNodeFromSelector, jsdomIt } from './tests/util.js';

jsdomIt('should add element "thing" in the SVG', ({ svg }) => {
  // Code in this block runs in a pseudo-browser environment
  addThing(svg); // The svg item is the D3 selection of the SVG node
  const svgNode = ensureNodeFromSelector('svg'); // Retrieve the DOM node using the DOM API
  expect(svgNode.querySelector('thing')).not.toBeNull(); // Test the structure of the SVG
});

They can be used to test any method that interacts with the DOM, including for testing renderers. For renderers, additional integration testing is necessary to test the layout though.

Integration / End-to-End (E2E) Tests

These test the rendering and visual appearance of the diagrams.

This ensures that the rendering of that feature in the E2E will be reviewed in the release process going forward. Less chance that it breaks!

To start working with the E2E tests:

Host

  • Run pnpm dev to start the dev server
  • Start Cypress by running pnpm cypress:open

Docker

  • Enable local connections for x11 server xhost +local:
  • Run ./run pnpm dev to start the dev server
  • Start Cypress by running ./run pnpm cypress:open --project .

The rendering tests are very straightforward to create. There is a function imgSnapshotTest, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress.

When running in CI it will take a snapshot of the rendered diagram and compare it with the snapshot from last build and flag it for review if it differs. When the changes in PR only apply to specific diagrams, only the rendering tests for those diagrams will be run in CI. If a change is not related to a specific diagram, the full test-suite will be run.

This is what a rendering test looks like:

js
it('should render forks and joins', () => {
  imgSnapshotTest(
    `
    stateDiagram
    state fork_state &lt;&lt;fork&gt;&gt;
      [*] --> fork_state
      fork_state --> State2
      fork_state --> State3

      state join_state &lt;&lt;join&gt;&gt;
      State2 --> join_state
      State3 --> join_state
      join_state --> State4
      State4 --> [*]
    `,
    { logLevel: 0 }
  );
});

Update Documentation

💡 Tip
Our documentation is managed in packages/mermaid/src/docs. Details on how to edit is in the documentation section

If the users have no way to know that things have changed, then you haven't really fixed anything for the users; you've just added to making Mermaid feel broken.
Likewise, if users don't know that there is a new feature that you've implemented, it will forever remain unknown and unused.

The documentation has to be updated for users to know that things have been changed and added!
If you are adding a new feature, add (v<MERMAID_RELEASE_VERSION>+) in the title or description. It will be replaced automatically with the current version number when the release happens.

eg: # Feature Name (v<MERMAID_RELEASE_VERSION>+)

We know it can sometimes be hard to code and write user documentation.

Create another issue specifically for the documentation.
You will need to help with the PR, but definitely ask for help if you feel stuck.
When it feels hard to write stuff out, explaining it to someone and having that person ask you clarifying questions can often be 80% of the work!

When in doubt, write up and submit what you can. It can be clarified and refined later. (With documentation, something is better than nothing!)

Contributing Documentation

If it is not in the documentation, it's like it never happened. Wouldn't that be sad? With all the effort that was put into the feature?

Where is the Documentation Located?

Warning
DO NOT CHANGE FILES IN /docs

The docs folder will be automatically generated when committing to packages/mermaid/src/docs and should not be edited manually.

Documentation is located in the packages/mermaid/src/docs folder. Just pick the right section and start typing.

The contents of mermaid.js.org are based on the docs from the master branch. Updates committed to the master branch are reflected in the Mermaid Docs once published.

mermaid-example
flowchart LR
  classDef default fill:#fff,color:black,stroke:black

  source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be published on Official Website"]
mermaid
flowchart LR
  classDef default fill:#fff,color:black,stroke:black

  source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be published on Official Website"]

Running the Documentation Website Locally

The mermaid documentation site is powered by Vitepress.

Start development server for the documentation site

Host

bash
pnpm --filter mermaid run docs:dev

or

bash
cd packages/mermaid
pnpm docs:dev

Docker

bash
./run docs:dev

Open http://localhost:3333/ in your browser.

Formatting

The documentation is written in Markdown. To get acquainted with its syntax see the GitHub Markdown help page.

You can use note, tip, warning and danger in triple backticks to add a note, tip, warning or danger box.

‼️ Danger
Do not use vitepress specific markdown syntax ::: warning as it will not be processed correctly.

Here are a few examples:

markdown
```note
This is a note
```

```tip
This is a tip
```

```warning
This is a warning
```

```danger
This is a danger alert
```

Note
This is a note

💡 Tip
This is a tip

Warning
This is a warning

‼️ Danger
This is a danger alert

If you want to propose changes to how the documentation is organized, such as adding a new section or re-arranging or renaming a section, you must update the sidebar navigation, which is defined in the vitepress config. The same goes for topbar.

Build Docs

The content of /docs folder is built with GitHub Actions.

Warning
So as to allow automatic compilation of documentation pages you have to enable GitHub Actions on your fork first

Submit your pull request

Note
Do not forget to push your changes

bash
git push -u origin docs/2910_update-guidelines

We make all changes via Pull Requests (PRs). Open a new one.

Right now we are not following any strict rules about naming PRs. Give it a representative title and short description. There is also a pull request template which will help you with it.

In case in its description contains a magic comment your PR will be automatically attached to the issue:

markdown
Resolves #<your issue ID here>

Congratulations

You have successfully submitted your improvements! What is next?

  • PRs will be reviewed by active maintainers, who will provide feedback and request changes as needed.
  • The maintainers will request a review from knsv, if necessary.
  • Once the PR is approved, the maintainers will merge the PR into the develop branch.
  • When a release is ready, the release/x.x.x branch will be created, extensively tested and knsv will be in charge of the release process.

Thanks for you help!

File: docs/community/intro.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/community/intro.md](../../packages/mermaid/src/docs/community/intro.md).

Getting Started

So you want to help? That's great!

Here are a few things to get you started on the right path.

How can I help?

mermaid
mindmap
  root)Contributing(
    Development
      Solving issues
      Adding new diagrams
      Handling pull requests
      Updating tooling
    Testing
      Verification of fixed issues
      Regression testing in connection with releases
      Testing pull requests
    Management
      Coordinating the work
      Classification and monitoring of incoming issues

Join the Development

💡 Tip
Check out our detailed contribution guide.

Where to start:

You can join our Discord server if you want closer contact!

A Question Or a Suggestion?

💡 Tip
Have a look at how to open an issue.

If you have faced a vulnerability report it to us.

Last Words

Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there.

You can join our Discord server if you want closer contact!

File: docs/community/new-diagram.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/community/new-diagram.md](../../packages/mermaid/src/docs/community/new-diagram.md).

Adding a New Diagram/Chart 📊

Examples

Warning
The below steps are a work in progress and will be updated soon.

Step 1: Grammar & Parsing

Please refer to the following PRs on how to use Langium to add a new diagram grammar.

The grammar language is documented here. The Langium Playground can help you test your diagram grammar against real inputs.

Step 2: Rendering

Write a renderer that given the data found during parsing renders the diagram. To look at an example look at sequenceRenderer.js rather than the flowchart renderer as this is a more generic example.

Place the renderer in the diagram folder.

Step 3: Detection of the new diagram type

The second thing to do is to add the capability to detect the new diagram to type to the detectType in diagram-api/detectType.ts. The detection should return a key for the new diagram type.
This key will be used to as the aria roledescription, so it should be a word that clearly describes the diagram type.
For example, if your new diagram uses a UML deployment diagram, a good key would be "UMLDeploymentDiagram" because assistive technologies such as a screen reader
would voice that as "U-M-L Deployment diagram." Another good key would be "deploymentDiagram" because that would be voiced as "Deployment Diagram." A bad key would be "deployment" because that would not sufficiently describe the diagram.

Note that the diagram type key does not have to be the same as the diagram keyword chosen for the grammar, but it is helpful if they are the same.

Common parts of a diagram

There are a few features that are common between the different types of diagrams. We try to standardize the diagrams that work as similar as possible for the end user. The commonalities are:

  • Directives, a way of modifying the diagram configuration from within the diagram code.
  • Accessibility, a way for an author to provide additional information like titles and descriptions to people accessing a text with diagrams using a screen reader.
  • Themes, there is a common way to modify the styling of diagrams in Mermaid.
  • Comments should follow mermaid standards

Here are some pointers on how to handle these different areas.

Accessibility

Mermaid automatically adds the following accessibility information for the diagram SVG HTML element:

  • aria-roledescription
  • accessible title
  • accessible description

aria-roledescription

The aria-roledescription is automatically set to the diagram type and inserted into the SVG element.

See the definition of aria-roledescription in the Accessible Rich Internet Applications W3 standard.

accessible title and description

The syntax for accessible titles and descriptions is described in the Accessibility documentation section.

The functions for setting title and description are provided by a common module. This is the import in flowDb.js:

text
import {
  setAccTitle,
  getAccTitle,
  getAccDescription,
  setAccDescription,
  clear as commonClear,
} from '../../commonDb';

The accessibility title and description are inserted into the SVG element in the render function in mermaidAPI.

Theming

Mermaid supports themes and has an integrated theming engine. You can read more about how the themes can be used in the docs.

When adding themes to a diagram it comes down to a few important locations in the code.

The entry point for the styling engine is in src/styles.js. The getStyles function will be called by Mermaid when the styles are being applied to the diagram.

This function will in turn call a function your diagram should provide returning the css for the new diagram. The diagram specific, also which is commonly also called getStyles and located in the folder for your diagram under src/diagrams and should be named styles.js. The getStyles function will be called with the theme options as an argument like in the following example:

js
const getStyles = (options) =>
  `
    .line {
      stroke-width: 1;
      stroke: ${options.lineColor};
      stroke-dasharray: 2;
    }
    // ...
    `;

Note that you need to provide your function to the main getStyles by adding it into the themes object in src/styles.js like in the xyzDiagram in the provided example:

js
const themes = {
  flowchart,
  'flowchart-v2': flowchart,
  sequence,
  xyzDiagram,
  //...
};

The actual options and values for the colors are defined in src/theme/theme-[xyz].js. If you provide the options your diagram needs in the existing theme files then the theming will work smoothly without hiccups.

Examples

The @mermaid-js/examples package contains a collection of examples that are used by tools like mermaid.live to help users get started with the new diagram.

You can duplicate an existing diagram example file, eg: packages/examples/src/examples/flowchart.ts, and modify it with details specific to your diagram.

Then you can import the example in the packages/examples/src/index.ts file and add it to the examples array.

Each diagram should have at least one example, and that should be marked as default. It is good to add more examples to showcase different features of the diagram.

File: docs/community/new-diagram-jison.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/community/new-diagram-jison.md](../../packages/mermaid/src/docs/community/new-diagram-jison.md).

Adding a New Diagram/Chart (Deprecated) 📊

Warning
JISON grammars are deprecated in mermaid. Please use Langium instead. See New Diagram for more information.

New diagrams with JISON grammars will not be accepted.

Step 1: Grammar & Parsing

Grammar

This would be to define a JISON grammar for the new diagram type. That should start with a way to identify that the text in the mermaid tag is a diagram of that type. Create a new folder under diagrams for your new diagram type and a parser folder in it. This leads us to step 2.

For instance:

  • the flowchart starts with the keyword graph
  • the sequence diagram starts with the keyword sequenceDiagram

Store data found during parsing

There are some jison specific sub steps here where the parser stores the data encountered when parsing the diagram, this data is later used by the renderer. You can during the parsing call an object provided to the parser by the user of the parser. This object can be called during parsing for storing data.

jison
statement
	: 'participant' actor  { $$='actor'; }
	| signal               { $$='signal'; }
	| note_statement       { $$='note';  }
	| 'title' message      { yy.setTitle($2);  }
	;

In the extract of the grammar above, it is defined that a call to the setTitle method in the data object will be done when parsing and the title keyword is encountered.

Note
Make sure that the parseError function for the parser is defined and calling mermaid.parseError. This way a common way of detecting parse errors is provided for the end-user.

For more info look at the example diagram type:

The yy object has the following function:

javascript
exports.parseError = function (err, hash) {
  mermaid.parseError(err, hash);
};

when parsing the yy object is initialized as per below:

javascript
const parser = exampleParser.parser;
parser.yy = db;

Step 2: Rendering

Write a renderer that given the data found during parsing renders the diagram. To look at an example look at sequenceRenderer.js rather than the flowchart renderer as this is a more generic example.

Place the renderer in the diagram folder.

Step 3: Detection of the new diagram type

The second thing to do is to add the capability to detect the new diagram to type to the detectType in diagram-api/detectType.ts. The detection should return a key for the new diagram type.
This key will be used to as the aria roledescription, so it should be a word that clearly describes the diagram type.
For example, if your new diagram uses a UML deployment diagram, a good key would be "UMLDeploymentDiagram" because assistive technologies such as a screen reader
would voice that as "U-M-L Deployment diagram." Another good key would be "deploymentDiagram" because that would be voiced as "Deployment Diagram." A bad key would be "deployment" because that would not sufficiently describe the diagram.

Note that the diagram type key does not have to be the same as the diagram keyword chosen for the grammar, but it is helpful if they are the same.

Step 4: The final piece - triggering the rendering

At this point when mermaid is trying to render the diagram, it will detect it as being of the new type but there will be no match when trying to render the diagram. To fix this add a new case in the switch statement in main.js:init this should match the diagram type returned from step #2. The code in this new case statement should call the renderer for the diagram type with the data found by the parser as an argument.

Usage of the parser as a separate module

Setup

javascript
const graph = require('./graphDb');
const flow = require('./parser/flow');
flow.parser.yy = graph;

Parsing

javascript
flow.parser.parse(text);

Data extraction

javascript
graph.getDirection();
graph.getVertices();
graph.getEdges();

The parser is also exposed in the mermaid api by calling:

javascript
const parser = mermaid.getParser();

Note that the parse needs a graph object to store the data as per:

javascript
flow.parser.yy = graph;

Look at graphDb.js for more details on that object.

Layout

If you are using a dagre based layout, please use flowchart-v2 as a template and by doing that you will be using dagre-wrapper instead of dagreD3 which we are migrating away from.

Common parts of a diagram

There are a few features that are common between the different types of diagrams. We try to standardize the diagrams that work as similar as possible for the end user. The commonalities are:

  • Directives, a way of modifying the diagram configuration from within the diagram code.
  • Accessibility, a way for an author to provide additional information like titles and descriptions to people accessing a text with diagrams using a screen reader.
  • Themes, there is a common way to modify the styling of diagrams in Mermaid.
  • Comments should follow mermaid standards

Here are some pointers on how to handle these different areas.

Accessibility

Mermaid automatically adds the following accessibility information for the diagram SVG HTML element:

  • aria-roledescription
  • accessible title
  • accessible description

aria-roledescription

The aria-roledescription is automatically set to the diagram type and inserted into the SVG element.

See the definition of aria-roledescription in the Accessible Rich Internet Applications W3 standard.

accessible title and description

The syntax for accessible titles and descriptions is described in the Accessibility documentation section.

As a design goal, the jison syntax should be similar between the diagrams.

jison
* lexical grammar */
%lex
%x acc_title
%x acc_descr
%x acc_descr_multiline

%%
accTitle\s*":"\s*                                { this.begin("acc_title");return 'acc_title'; }
<acc_title>(?!\n|;|#)*[^\n]*                     { this.popState(); return "acc_title_value"; }
accDescr\s*":"\s*                                { this.begin("acc_descr");return 'acc_descr'; }
<acc_descr>(?!\n|;|#)*[^\n]*                     { this.popState(); return "acc_descr_value"; }
accDescr\s*"{"\s*                                { this.begin("acc_descr_multiline");}
<acc_descr_multiline>[\}]                        { this.popState(); }
<acc_descr_multiline>[^\}]*                      return "acc_descr_multiline_value";

statement
    : acc_title acc_title_value  { $$=$2.trim();yy.setTitle($$); }
    | acc_descr acc_descr_value  { $$=$2.trim();yy.setAccDescription($$); }
    | acc_descr_multiline_value { $$=$1.trim();yy.setAccDescription($$); }

The functions for setting title and description are provided by a common module. This is the import from flowDb.js:

text
import {
  setAccTitle,
  getAccTitle,
  getAccDescription,
  setAccDescription,
  clear as commonClear,
} from '../../commonDb';

The accessibility title and description are inserted into the SVG element in the render function in mermaidAPI.

Theming

Mermaid supports themes and has an integrated theming engine. You can read more about how the themes can be used in the docs.

When adding themes to a diagram it comes down to a few important locations in the code.

The entry point for the styling engine is in src/styles.js. The getStyles function will be called by Mermaid when the styles are being applied to the diagram.

This function will in turn call a function your diagram should provide returning the css for the new diagram. The diagram specific, also which is commonly also called getStyles and located in the folder for your diagram under src/diagrams and should be named styles.js. The getStyles function will be called with the theme options as an argument like in the following example:

js
const getStyles = (options) =>
  `
    .line {
      stroke-width: 1;
      stroke: ${options.lineColor};
      stroke-dasharray: 2;
    }
    // ...
    `;

Note that you need to provide your function to the main getStyles by adding it into the themes object in src/styles.js like in the xyzDiagram in the provided example:

js
const themes = {
  flowchart,
  'flowchart-v2': flowchart,
  sequence,
  xyzDiagram,
  //...
};

The actual options and values for the colors are defined in src/theme/theme-[xyz].js. If you provide the options your diagram needs in the existing theme files then the theming will work smoothly without hiccups.

File: docs/community/questions-and-suggestions.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/community/questions-and-suggestions.md](../../packages/mermaid/src/docs/community/questions-and-suggestions.md).

Questions or Suggestions?

Search for Existing Issue

First search to see if someone has already asked (and hopefully been answered) or suggested the same thing.

If you find an open issue or discussion thread that is similar to your question but isn't answered, you can let us know that you are also interested in it.
Use the GitHub reactions to add a thumbs-up to the issue or discussion thread, or append to the issue if needed.

This helps the team know the relative interest in something and helps them set priorities and assignments.

Add a new Issue

You have not found anything that already addresses your request, or maybe you have come up with the new idea? Feel free to open a new issue or discussion.

Log in to GitHub.com, and use GitHub issue tracker of the mermaid-js repository. Press issue, select the appropriate template and describe your problem.

File: docs/community/security.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/community/security.md](../../packages/mermaid/src/docs/community/security.md).

Security

The Mermaid team takes the security of Mermaid and the applications that use Mermaid seriously. This page describes how to report any vulnerabilities you may find, and lists best practices to minimize the risk of introducing a vulnerability.

Reporting vulnerabilities

To report a vulnerability, please e-mail [email protected] with a description of the issue, the steps you took to create the issue, affected versions, and if known, mitigations for the issue.

We aim to reply within three working days, probably much sooner.

You should expect a close collaboration as we work to resolve the issue you have reported. Please reach out to [email protected] again if you do not receive prompt attention and regular updates.

You may also reach out to the team via our public Discord chat channels; however, please make sure to e-mail [email protected] when reporting an issue, and avoid revealing information about vulnerabilities in public as that could that could put users at risk.

Best practices

Keep current with the latest Mermaid releases. We regularly update Mermaid, and these updates may fix security defects discovered in previous versions. Check the Mermaid release notes for security-related updates.

Keep your application’s dependencies up to date. Make sure you upgrade your package dependencies to keep the dependencies up to date. Avoid pinning to specific versions for your dependencies and, if you do, make sure you check periodically to see if your dependencies have had security updates, and update the pin accordingly.

Configuring DomPurify

By default Mermaid uses a baseline DOMPurify config. It is possible to override the options passed to DOMPurify by adding a dompurifyConfig key to the Mermaid options. This could potentially break the output of Mermaid so use this with caution.

File: docs/config/setup/mermaid/interfaces/DetailedError.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/DetailedError.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/DetailedError.md).

mermaid

Interface: DetailedError

Defined in: packages/mermaid/src/utils.ts:782

Properties

error?

optional error: any

Defined in: packages/mermaid/src/utils.ts:787

hash

hash: any

Defined in: packages/mermaid/src/utils.ts:785

message?

optional message: string

Defined in: packages/mermaid/src/utils.ts:788

str

str: string

Defined in: packages/mermaid/src/utils.ts:783

File: docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/ExternalDiagramDefinition.md).

mermaid

Interface: ExternalDiagramDefinition

Defined in: packages/mermaid/src/diagram-api/types.ts:104

Properties

detector

detector: DiagramDetector

Defined in: packages/mermaid/src/diagram-api/types.ts:106

id

id: string

Defined in: packages/mermaid/src/diagram-api/types.ts:105

loader

loader: DiagramLoader

Defined in: packages/mermaid/src/diagram-api/types.ts:107

File: docs/config/setup/mermaid/interfaces/LayoutData.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutData.md](../../../../../packages/mermaid/src/docs/config/setup/mermaid/interfaces/LayoutData.md).

mermaid

Interface: LayoutData

Defined in: packages/mermaid/src/rendering-util/types.ts:214

Indexable

[key: string]: any

Properties

config

config: MermaidConfig

Defined in: packages/mermaid/src/rendering-util/types.ts:217

diagramId?

optional diagramId: string

Defined in: packages/mermaid/src/rendering-util/types.ts:218

edges

edges: Edge[]

Defined in: packages/mermaid/src/rendering-util/types.ts:216

nodes

nodes: Node[]

Defined in: packages/mermaid/src/rendering-util/types.ts:215

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#diagrams Browse diagrams catalog → #diagrams-as-code Browse diagrams-as-code catalog → #documentation Browse documentation catalog → #flowchart Browse flowchart catalog → #javascript Browse javascript catalog → #mindmap Browse mindmap catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →