# mermaid-chart/mermaid-develop architecture

> Architecture diagram of the GitHub repository mermaid-chart/mermaid-develop, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mermaid-chart/mermaid-develop
- Repository: https://github.com/mermaid-chart/mermaid-develop

## Overview

##### File structure
- Root config: CI workflows (.github/workflows), linters, build scripts (vite.config.ts, .vite), Docker compose for local dev, Cypress/E2E tests, demos/, docs/ (static site), scripts/, tests/webpack.
- package.json + pnpm-workspace manage dependencies and workspaces.

##### README for additional insights
- Core flow: markdown-inspired text → mermaidAPI → detect type → parse → AST/Db → renderer → SVG/HTML.
- Integrations: Node API, browser API, CLI, Live Editor, GitHub, other host apps.
- Visual regression using Applitools in E2E.

##### Main components & their interactions
a. Clients / Entry Points:
– Browser bundler (via ESM bundle built by Vite/Rollup)
– Live Editor (separate repo but uses core API)
3) Parser: Jison grammars produce intermediate data models (Db objects)
5) Rendering-Util: shared utilities (text splitting, markdown handling, DOM helpers)
6) Themes & Styles: CSS/JS themes applied at render time
7) Config & Schemas: default/final config, type definitions, validation
8) Logger, Errors, Accessibility modules
c. Plugin Packages:
d. Documentation & Demos:
– docs/ (static markdown site via Vitepress), demos/ (static HTML examples)
e. CI/CD & Testing:
– GitHub Actions orchestrate lint, build, test, publish
– Cypress for visual and functional E2E tests with Applitools
– Jest/Mocha for unit tests in each package
f. Packaging & Publishing:
– pnpm workspaces, root & each package package.json
– build scripts in scripts/ and .vite/
– npm publish to registry, site deploy via Netlify

##### Architectural patterns & design principles
- Modular plugin architecture: detectors + parsers + renderers register under mermaidAPI
- Pipeline pattern: text → detect → parse → render
- Monorepo with workspace orchestration for code reuse and version alignment
- CI pipeline ensures consistency across packages and documentation

##### Elements
- Clear labels for each component (e.g., “Detector”, “Flowchart Parser”, “Theme Engine”)
– Rectangles for code modules
– Parallelograms for inputs/outputs (text input, SVG output)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Clients Layer
    subgraph "Clients"
        Browser["Browser ESM Bundle"]:::runtime
        CLI["Node/CLI (mermaid-cli)"]:::runtime
    end

    %% Core Pipeline Layer
    subgraph "Core Pipeline"
        TI[/Text Input/]:::runtime
        mermaidAPI["Core API (mermaidAPI)"]:::runtime
        Detector["Detector"]:::runtime
        Parser["Parser (Jison Grammars)"]:::runtime
        AST[(AST/Db)]:::runtime
        Renderer["Renderer"]:::runtime
        SO[/SVG/HTML Output/]:::runtime
        Themes["Themes & Styles"]:::utilities
        Config["Config & Schemas"]:::utilities
        Logger["Logger/Errors/Accessibility"]:::utilities
    end

    %% Diagram Modules & Utilities Layer
    subgraph "Diagram Modules"
        subgraph "Flowchart"
            FlowDef["Flowchart Definition"]:::runtime
            FlowParser["Flowchart Parser"]:::runtime
            FlowRenderer["Flow Renderer"]:::runtime
            FlowLayout["Flow Layout (elk)"]:::runtime
        end
        subgraph "Sequence"
            SeqDef["Sequence Definition"]:::runtime
            SeqRenderer["Sequence Renderer"]:::runtime
        end
    end

    RenderUtil["Rendering Utilities"]:::utilities

    %% Plugins Layer
    subgraph "Plugins"
        ExamplePlugin["Example Diagram Plugin"]:::runtime
        ZenUMLPlugin["ZenUML Plugin"]:::runtime
    end

    %% Docs & Demos Layer
    subgraph "Docs & Demos"
        DocsSite["Documentation Site (Vitepress)"]:::tooling
        StaticDocs["Static Docs"]:::tooling
        Demos["Demos/Examples"]:::tooling
    end

    %% CI/CD & Testing Layer
    subgraph "CI/CD & Testing"
        CI["CI Workflows"]:::tooling
        E2E["E2E Tests (Cypress/Applitools)"]:::tooling
        UnitTests["Unit Tests"]:::tooling
        BuildScripts["Build & Packaging Scripts"]:::tooling
    end

    %% Data Flow
    TI --> mermaidAPI --> Detector --> Parser --> AST --> Renderer --> SO
    Renderer --> SO
    Config --> mermaidAPI
    Config --> Detector
    Config --> Parser
    Config --> Renderer
    Themes --> Renderer
    RenderUtil --> Renderer
    Logger --> mermaidAPI
    Logger --> Detector
    Logger --> Parser
    Logger --> Renderer

    Detector --> FlowParser
    Detector --> SeqDef
    FlowParser --> AST
    SeqDef --> AST
    AST --> FlowRenderer
    AST --> SeqRenderer
    FlowRenderer --> SO
    FlowLayout --> FlowRenderer
    SeqRenderer --> SO

    ExamplePlugin --> Detector
    ExamplePlugin --> Parser
    ExamplePlugin --> FlowRenderer

    ZenUMLPlugin --> Detector
    ZenUMLPlugin --> Parser
    ZenUMLPlugin --> SeqRenderer

    DocsSite --> mermaidAPI
    StaticDocs --> mermaidAPI
    Demos --> mermaidAPI

    CI --> BuildScripts
    CI --> UnitTests
    CI --> E2E
    BuildScripts --> mermaidAPI

    Browser --> mermaidAPI
    CLI --> mermaidAPI

    %% Click Events
    click mermaidAPI "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/mermaidAPI.ts"
    click Detector "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagram-api/detectType.ts"
    click FlowParser "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagrams/flowchart/parser/flow.jison"
    click FlowDef "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagrams/flowchart/flowDiagram.ts"
    click FlowRenderer "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagrams/flowchart/flowRenderer.js"
    click FlowLayout "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagrams/flowchart/elk/flowRenderer-elk.js"
    click SeqDef "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagrams/sequence/sequenceDiagram.ts"
    click SeqRenderer "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/diagrams/sequence/sequenceRenderer.ts"
    click RenderUtil "https://github.com/mermaid-chart/mermaid-develop/tree/develop/packages/mermaid/src/rendering-util"
    click Themes "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/styles.ts"
    click Config "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/config.ts"
    click Logger "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/logger.ts"
    click StaticDocs "https://github.com/mermaid-chart/mermaid-develop/tree/develop/docs/"
    click DocsSite "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/docs/.vitepress"
    click Demos "https://github.com/mermaid-chart/mermaid-develop/tree/develop/demos/"
    click CI "https://github.com/mermaid-chart/mermaid-develop/tree/develop/.github/workflows/"
    click E2E "https://github.com/mermaid-chart/mermaid-develop/tree/develop/cypress/"
    click UnitTests "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/**/*.spec.ts"
    click BuildScripts "https://github.com/mermaid-chart/mermaid-develop/tree/develop/scripts/"
    click CLI "https://github.com/mermaid-chart/mermaid-develop/blob/develop/packages/mermaid/src/mermaid.ts"
    click Browser "https://github.com/mermaid-chart/mermaid-develop/blob/develop/vite.config.ts"

    %% Styles
    classDef runtime fill:#e0f7ff,stroke:#005b96,color:#000;
    classDef utilities fill:#e0ffe0,stroke:#007f00,color:#000;
    classDef tooling fill:#f0f0f0,stroke:#888888,color:#000;
```
