How mermaid-js/mermaid works
Mermaid turns Markdown-inspired diagram text into rendered diagrams; its README describes this author-to-result workflow and broad diagramming purpose. The graph groups the core runtime, diagram implementations, rendering/layout machinery, and companion editor and packages. Source excerpts expose diagram registration, editor wiring, and selected internal calls; other subsystem links are included only where documented, and unsampled internals are represented at directory level.
Main entry points: mermaidAPI.ts Mermaid API · app.js Local Editor · diagrams Diagram Implementations · parse.ts Parser Package
Components 23
Mermaid Runtime
- Mermaid API
packages/mermaid/src/mermaidAPI.ts - Diagram Registry
packages/mermaid/src/diagram-api/diagram-orchestration.ts - Configuration
packages/mermaid/src/config.type.ts - Shared Diagram Data
packages/mermaid/src/diagrams/common/populateCommonDb.ts
Diagram Types
- Diagram Implementations
packages/mermaid/src/diagrams - Git Graph Parser
packages/mermaid/src/diagrams/git/gitGraphParser.ts - Git Graph AST
packages/mermaid/src/diagrams/git/gitGraphAst.ts - Use Case Parser
packages/mermaid/src/diagrams/usecase/parser/usecase.parser.ts - Wardley Parser
packages/mermaid/src/diagrams/wardley/wardleyParser.ts - Parser Package
packages/parser/src/parse.ts
Rendering And Layout
- Diagram Rendering
packages/mermaid/src/diagrams - Shared Layout Utilities
packages/mermaid/src/rendering-util/layout-algorithms - Swimlane Layout
packages/mermaid/src/rendering-util/layout-algorithms/swimlanes/pipeline.ts - Orthogonal Router
packages/mermaid/src/rendering-util/layout-algorithms/swimlanes/orthogonalRouter/router.ts - XY Chart Builder
packages/mermaid/src/diagrams/xychart/chartBuilder/orchestrator.ts - Tidy Tree Layout
packages/mermaid-layout-tidy-tree/src/layout.ts
Editor And Extensions
- Local Editor
packages/mermaid-local-editor/static/app.js - Diagram Storage
packages/mermaid-local-editor/static/js/storage.js - Editor Preview
packages/mermaid-local-editor/static/js/renderer.js - Example Diagram
packages/mermaid-example-diagram/src/exampleDiagramRenderer.js - ZenUML Extension
packages/mermaid-zenuml/src/zenumlRenderer.ts
Other components
- Diagram Author
- Rendered Diagram
Connections 17
- Diagram Author → Mermaid API: provides text
README.md - Mermaid API → Diagram Registry: selects diagram
- Diagram Registry → Diagram Implementations: registers detectors
packages/mermaid/src/diagram-api/diagram-orchestration.ts - Mermaid API → Rendered Diagram: renders diagrams
README.md - Diagram Implementations → Diagram Rendering: renders
README.md - Git Graph Parser → Parser Package: uses parser package
packages/mermaid/src/diagrams/git/gitGraphParser.ts - Wardley Parser → Parser Package: uses parser package
packages/mermaid/src/diagrams/wardley/wardleyParser.ts - Git Graph Parser → Git Graph AST: uses AST
packages/mermaid/src/diagrams/git/gitGraphParser.ts - Use Case Parser → Parser Package: uses tokens
packages/mermaid/src/diagrams/usecase/parser/usecase.parser.ts - Diagram Implementations → Shared Diagram Data: shares diagram data
packages/mermaid/src/diagrams/wardley/wardleyParser.ts - Diagram Rendering → Shared Layout Utilities: uses layout
- Swimlane Layout → Orthogonal Router: routes edges
- Local Editor → Diagram Storage: persists diagrams
packages/mermaid-local-editor/static/app.js - Local Editor → Editor Preview: renders preview
packages/mermaid-local-editor/static/app.js - Local Editor → Mermaid API: initializes runtime
- XY Chart Builder → Diagram Rendering: provides components
packages/mermaid/src/diagrams/xychart/chartBuilder/orchestrator.ts - Tidy Tree Layout → Shared Layout Utilities: provides layout