Skip to content

Main Navigation Docs Tutorials Integrations Contributing Latest News

💻 Open Editor

Appearance

Sidebar Navigation

📔 Introduction

About Mermaid

Getting Started

Syntax and Configuration

📊 Diagram Syntax

Flowchart

Swimlanes Diagram

Sequence Diagram

Class Diagram

State Diagram

Entity Relationship Diagram

User Journey

Gantt

Pie Chart

Quadrant Chart

Requirement Diagram

GitGraph (Git) Diagram

C4 Diagram 🦺⚠️

Mindmaps

Timeline

ZenUML

Sankey 🔥

XY Chart 🔥

Block Diagram 🔥

Packet 🔥

Kanban 🔥

Architecture 🔥

Radar 🔥

Event Modeling 🔥

Treemap 🔥

Venn 🔥

Ishikawa 🔥

Wardley 🔥

Cynefin 🔥

TreeView 🔥

Other Examples

📚 Ecosystem

Mermaid Chart

Tutorials

Integrations - Community

Integrations - Create

⚙️ Deployment and Configuration

Configuration

API-Usage

Mermaid API Configuration

Mermaid Configuration Options

Registering icons

Directives

Theming

Math

Accessibility

Mermaid CLI

FAQ

Layouts

🙌 Contributing

Getting Started

Contributing to Mermaid

Adding Diagrams

Questions and Suggestions

Security

📰 Latest News

Announcements

Blog

On this page

config

Variables

defaultConfig

Functions

addDirective
evaluate
getConfig
getEffectiveHtmlLabels
getSiteConfig
getUserDefinedConfig
reset
sanitize
saveConfigFromInitialize
~~setConfig~~
setSiteConfig
updateSiteConfig

Edit this page on GitHub

Pager

Next pageAbout Mermaid

Opens in mermaid.ai