Weekly GitHub Report for Mermaid

Thank you for subscribing to our weekly newsletter! Each week, we deliver a comprehensive summary of your GitHub project's latest activity right to your inbox, including an overview of your project's issues, pull requests, contributors, and commit activity.

Table of Contents

• I. News
  • 1.1. Recent Version Releases
  • 1.2. Other Noteworthy Updates
• II. Issues
  • 2.1. Top 5 Active Issues
  • 2.2. Top 5 Stale Issues
  • 2.3. Open Issues
  • 2.4. Closed Issues
  • 2.5. Issue Discussion Insights

• III. Pull Requests
  • 3.1. Open Pull Requests
  • 3.2. Closed Pull Requests
  • 3.3. Pull Request Discussion Insights

• IV. Contributors
  • 4.1. Contributors

I. News

1.1 Recent Version Releases:

The current version of this repository is @mermaid-js/[email protected]

1.2 Version Information:

On March 25, 2025, a minor update was released that introduced the addition of a Radar Chart feature, enhancing the charting capabilities of the platform. This update reflects ongoing efforts to expand visualization options.

II. Issues

2.1 Top 5 Active Issues:

We consider active issues to be issues that that have been commented on most frequently within the last week. Bot comments are omitted.

1. [TYPE: ENHANCEMENT] [CONTRIBUTOR NEEDED] [STATUS: PENDING] [GOOD FIRST ISSUE!] [AREA: DEVELOPMENT] [TYPE: NEW DIAGRAM] Support for Circular Flow Diagram: This issue requests the addition of support for creating circular flow diagrams in Mermaid, as current flowchart layouts do not produce visually appealing or truly circular diagrams. The discussion explores possible solutions including new layout algorithms like force-directed or circular layouts, syntax proposals for specifying circular graphs with directional options, and various workarounds and examples contributed by users to approximate circular diagrams until native support is implemented.

   • The comments include users sharing interim workarounds using different edge styles and block diagrams, detailed proposals for syntax and features of circular flow diagrams, considerations about directionality and labeling, and references to existing layout algorithms and external tools; there is also encouragement for contributions and a shared prototype of a new circular layout implementation.
   • Number of comments this week: 1

2. [TYPE: BUG / ERROR] [STATUS: APPROVED] [GRAPH: SEQUENCE] [GOOD FIRST ISSUE!] Sequence Diagram "Note over A" KaTeX extra padding: This issue reports a problem with excessive padding when using the "Note over" syntax in sequence diagrams with KaTeX rendering, whereas using "Note left of" does not produce this padding issue. The user provides a minimal reproducible example and notes that the problem occurs across multiple browsers and Mermaid versions, seeking a fix for the unnecessary padding in the rendering logic.

   • The comments include a contributor offering to fix the issue by removing unnecessary recalculations in the rendering code and requesting assignment to submit a PR, followed by a query about deployment difficulties and contribution barriers.
   • Number of comments this week: 1

3. [TYPE: ENHANCEMENT] [CONTRIBUTOR NEEDED] [STATUS: APPROVED] [AREA: DOCUMENTATION] [GRAPH: SEQUENCE] [GOOD FIRST ISSUE!] [TYPE: DOCUMENTATION] docs: Add comprehensive color configuration guide for sequenceDiagram: This issue proposes adding a comprehensive guide to color configuration in sequence diagrams to improve documentation clarity and usability. It aims to consolidate scattered information about coloring individual boxes, actors, themes, and supported color formats, providing practical examples and theme integration tips.

   • The comments include requests to add labels, agreement on the need for improved documentation, approval of the issue, encouragement to submit a pull request, an offer to work on the issue, permission granted to proceed, and a query about the feature's delivery status.
   • Number of comments this week: 1

4. [TYPE: ENHANCEMENT] [CONTRIBUTOR NEEDED] [STATUS: APPROVED] [TYPE: NEW DIAGRAM] [REQUIRED GROOMING] Add Native BPMN 2.0 Support to Mermaid.js: This issue proposes adding native support for Business Process Model and Notation (BPMN 2.0) to Mermaid.js, aiming to fill a gap for users who need to embed formal BPMN diagrams in Markdown and version-controlled documentation. The proposal includes a tiered syntax model to balance expressiveness and simplicity, an initial MVP scope focusing on core BPMN elements, and plans to share an implementation branch for early community feedback.

   • The comments provide constructive feedback on the proposed DSL syntax, suggesting a tiered approach to reduce verbosity and improve usability, and endorse scoping the initial implementation to a manageable subset of BPMN features. Contributors also share alternative prototypes and discuss syntax trade-offs, emphasizing collaboration and early architectural review to ensure the feature aligns with Mermaid’s design philosophy and community needs.
   • Number of comments this week: 1

5. [TYPE: ENHANCEMENT] [STATUS: TRIAGE] Enhancement: add Chinese (zh-CN) localization for diagram labels: This issue requests the addition of Chinese (zh-CN) localization for built-in diagram labels and error messages in Mermaid to enhance accessibility for Chinese-speaking developers. The goal is to implement a locale configuration and translate key error messages and diagram labels, starting with a minimal viable approach before expanding to more comprehensive translations.

   • The comments discuss an initial plan to create a locale configuration and translate primary error messages first, followed by a pull request that introduces a minimal implementation focusing on error diagrams and a locale option, while deliberately keeping developer-facing error messages in English to maintain debuggability.
   • Number of comments this week: 1

2.2 Top 5 Stale Issues:

We consider stale issues to be issues that has had no activity within the last 30 days. The team should work together to get these issues resolved and closed as soon as possible.

As of our latest update, there are no stale issues for the project this week.

2.3 Open Issues

This section lists, groups, and then summarizes issues that were created within the last week in the repository.

Issues Opened This Week: 8

Summarized Issues:

• Label and Layout Rendering Issues: Several issues describe problems with diagram rendering and layout, including overlapping vertical labels on Gantt charts that reduce readability and nested subgraphs extending beyond parent boundaries due to incorrect width calculations. These rendering bugs affect the visual clarity and usability of diagrams, necessitating fixes to improve automatic layout and label management.
• [issues/8026, issues/8035]

• Parsing and Syntax Errors: Multiple issues highlight parsing problems in Mermaid diagrams, such as lexical errors caused by forbidden characters in titles and incorrect attribute handling that leads to visible screen-reader text. These parsing bugs prevent diagrams from rendering correctly and produce misleading error messages, impacting user experience and accessibility.
• [issues/8030, issues/8040]

• Layout Configuration Enhancements: There is a request for improved ELK layout options, including the ability to specify cycle breaking strategies and per-node layout constraints to better control diagram structure and prevent undesired edge reversals. These enhancements aim to provide users with finer control over diagram readability and flow.
• [issues/8036]

• Sequence Diagram Line Break Bug: A bug in sequence diagrams causes explicit <br/> line breaks to be ignored in subsequent messages due to regex state issues, resulting in incorrect word wrapping and loss of intended formatting. This affects the accurate display of multiline messages in sequence diagrams.
• [issues/8037]

• New Diagram Type Proposal: A proposal suggests adding a "breadboard" UX design diagram type to explicitly model user interface flows with places and affordances, addressing limitations in existing flowchart syntax for representing UI structure and interactions. This new diagram type aims to improve the expressiveness and clarity of UI flow representations.
• [issues/8043]

• CI/CD Deployment Issue: The Netlify deploy-preview check has been failing on all open pull requests since early August 2026, causing unstable status indicators regardless of actual PR quality. This issue obscures the true readiness of PRs and requires investigation by someone with access to Netlify build logs.
• [issues/8049]

2.4 Closed Issues

This section lists, groups, and then summarizes issues that were closed within the last week in the repository. This section also links the associated pull requests if applicable.

Issues Closed This Week: 2

Summarized Issues:

• Subgraph Direction Behavior: The documented behavior that subgraph direction is ignored when subgraph nodes are linked externally does not hold true, as links stop at the subgraph border instead of reaching the node when a direction is set. This causes inconsistencies in Mermaid flowchart rendering, affecting the expected visualization output.
• issues/8002

• Compatibility Issues: Chevrotain version 12 is incompatible with Node.js version 20, resulting in breakage within the project. This incompatibility disrupts the normal functioning and requires attention to maintain stability.
• issues/8027

2.5 Issue Discussion Insights

This section will analyze the tone and sentiment of discussions within this project's open and closed issues that occurred within the past week. It aims to identify potentially heated exchanges and to maintain a constructive project environment.

Based on our analysis, there are no instances of toxic discussions in the project's open or closed issues from the past week.

III. Pull Requests

3.1 Open Pull Requests

This section provides a summary of pull requests that were opened in the repository over the past week. The top three pull requests with the highest number of commits are highlighted as 'key' pull requests. Other pull requests are grouped based on similar characteristics for easier analysis. Up to 25 pull requests are displayed in this section, while any remaining pull requests beyond this limit are omitted for brevity.

Pull Requests Opened This Week: 12

Key Open Pull Requests

1. Feat/wireframe diagram: This pull request introduces native support for wireframe diagrams in Mermaid, enabling users to create detailed low-fidelity UI mockups with text-based syntax by implementing a Langium parser, a flexible multi-column layout engine with relative alignment, nested containers including tabs and accordions, a rich component library of form controls and icons, modular SVG renderers with two-pass layout computation, and comprehensive testing and documentation.

• URL: pull/8046

• Associated Commits: dbac0, e2ee5, e5ec0, 2dfa7, 6ebad, feb5f, eabb4, facf9, 71ad4, 6cd70, 9d088, 0589c, 9494a, 3eee7, 4003b, 5b372, 618c2, 67ec1, 50daf, 52c7f, cd155, 84ad2, cb977, 6f100, 7fe5e, 5eb70

2. feat(c4): lay out C4 diagrams with the unified pipeline: This pull request completes the migration of C4 diagram rendering to the unified layout pipeline by replacing the legacy row-grid layout with a graph-based dagre pipeline, removing the old renderer files, introducing a new LayoutData adapter and unified renderer, enabling proper hyperlink support, and refining styles and direction handling, resulting in more accurate and maintainable diagram layouts verified by extensive unit and visual tests.

• URL: pull/8042

• Associated Commits: 7c31e, 4078c, ac895, 39022, afb7a, 1aba6

3. fix(c4): allow hash characters in titles: This pull request fixes issue #8030 by modifying the C4 diagram lexer to allow hash (#) characters in titles, which previously caused parse errors, while ensuring that comment handling and other metadata lexer rules remain unchanged and adding regression tests to cover these cases.

• URL: pull/8031

• Associated Commits: 29122, 31cc5

Other Open Pull Requests

• Community Integrations - Other Section Additions: This topic covers pull requests that add new tools to the Community Integrations → Other section in the documentation. One PR introduces Line9, an alternative renderer for Mermaid flowcharts, while another adds the Mermaid Theme Builder, a browser-based visual governance workbench supporting 31 diagram families.
  • pull/8032, pull/8034

• Sankey Diagram Rendering Fix: This pull request fixes an issue in the Live Editor's Rough mode where thick Sankey diagram links with round caps extended beyond their nodes. It adds per-link SVG clip paths to constrain links horizontally within node boundaries while preserving the hand-drawn stroke style and includes a Cypress regression test to verify the fix.
  • pull/8025

• Label Wrapping and Line Break Preservation: This fix addresses the loss of explicit line breaks (<br/>) in wrapped labels caused by the use of a global regex .test() method. The solution replaces .test() with String.prototype.search() in hasBreaks() and updates wrapLabel() to preserve manually inserted line breaks without changing the API or documentation.
  • pull/8038

• C4 Diagram Parser Fixes: Multiple pull requests improve the C4 diagram parser by fixing lexical errors and accessibility title handling. One PR allows the # character in title and accDescription fields to prevent parsing failures, while another correctly assigns the accessible title using setAccTitle instead of overwriting the visible title, adding tests to avoid regressions.
  • pull/8039, pull/8041

• Internationalization (i18n) Feature Introduction: This pull request adds foundational internationalization support by introducing a configurable locale option with a minimal message catalog including Simplified Chinese (zh-CN). It enables global and per-diagram locale settings, translates rendered text like syntax error labels, keeps developer-facing errors in English, and falls back to English for missing translations or unsupported locales.
  • pull/8044

• ER Diagram Non-Latin Character Test Coverage: This PR adds test coverage for non-Latin characters in entity names and attribute types within ER diagrams. It re-enables a previously skipped test for accented characters and ensures regression protection for behavior introduced in version 11.5.0 without modifying production code.
  • pull/8045

• Gantt Chart Task Bar Rendering Bug Fix: This fix addresses a bug where Gantt chart task bars could incorrectly end on excluded days like weekends. It ensures the renderEndTime is updated to the fully-adjusted end date after accounting for excluded days, preventing visual misalignment and including updated tests and assertions to verify the fix.
  • pull/8047

3.2 Closed Pull Requests

This section provides a summary of pull requests that were closed in the repository over the past week. The top three pull requests with the highest number of commits are highlighted as 'key' pull requests. Other pull requests are grouped based on similar characteristics for easier analysis. Up to 25 pull requests are displayed in this section, while any remaining pull requests beyond this limit are omitted for brevity.

Pull Requests Closed This Week: 9

Key Closed Pull Requests

1. chore: merge v11.16.1 back to the develop branch: This pull request merges the v11.16.1 hotfixes, which include security fixes for prototype pollution, architecture refactoring to use Map instances, improvements to radar and XY charts, deprecation of certain API functions, and enhancements to example files and documentation, back into the develop branch to prevent future merge conflicts.

• URL: pull/8029

• Associated Commits: 57913, bffd4, e9e2b, a3d8d, b40b4, 2337f, 99af3, 59b22, 630aa, 2cd6d, 12d47, eba72, acc69, 95b1b, 7ecca, 35133, 45dcb

2. feat(shapes): add folder, bucket, console and browser shapes: This pull request adds four new general-purpose flowchart node shapes—folder (alias directory), bucket, console (terminal window), and browser—to the Mermaid diagramming tool, featuring both classic and hand-drawn rendering styles, shape-specific edge intersection logic, theme-driven decoration colors, comprehensive tests, updated documentation, and improvements to rendering stability and shape registration.

• URL: pull/7970

• Associated Commits: dcfda, b7fe4, 9d994, 9cbcc, cab05, 8f493, d67ed, af249, c6746

3. 6806: Adding support for the new use-case diagram type: This pull request adds support for a new use-case diagram type in the Mermaid project, including enhancements such as new arrow types, class definitions, styles, and fixes related to ellipse rendering and documentation updates.

• URL: pull/7081

• Associated Commits: 5fd06, 5e05f, 58c06, b7ff1, 5b2b3, b715d

Other Closed Pull Requests

• Performance improvements: This pull request integrates the fastdom library to batch DOM measurements and updates, reducing layout thrashing and unnecessary reflows. As a result, rendering large flowcharts in Mermaid is up to 25–30% faster.
• pull/7951

• Class diagram parser fixes: These changes fix the class diagram parser to correctly support nested generic types by enhancing the lexer to track nested ~ delimiters and emit balanced generic tokens. The generic formatting was updated to convert nested generics into escaped angle-bracket notation, and regression tests were added to ensure proper handling of complex nested generic class definitions.
• pull/7957

• Node 20 compatibility: This pull request addresses compatibility issues with Node 20 by pinning langium and langium-cli dependencies to version 4.2.1 to retain Chevrotain v11 and adding a pnpm override to prevent upgrades to Chevrotain v12, which requires Node 22+. Renovate updates for related packages were disabled, and the parser was verified to build and run without Node 21+ APIs like Object.groupBy.
• pull/8028

• Usecase diagram ANTLR parsing update: This chore update modifies the file structure of the usecase diagram component to support the new method of ANTLR parsing implementation.
• pull/7160

• Deprecation and documentation of mermaidAPI.setConfig(): These pull requests update the documentation to provide additional context on the deprecation of the mermaidAPI.setConfig() function and adjust the changeset level from a minor to a patch version bump, reflecting that the function is currently broken. Additionally, a release candidate for version 11.16.1 includes security fixes and officially deprecates this function due to its lack of utility.
• [pull/8024](https://github.com/mermaid-js/mermaid/pull/8024], pull/8022

3.3 Pull Request Discussion Insights

This section will analyze the tone and sentiment of discussions within this project's open and closed pull requests that occurred within the past week. It aims to identify potentially heated exchanges and to maintain a constructive project environment.

Based on our analysis, there are no instances of toxic discussions in the project's open or closed pull requests from the past week.

IV. Contributors

4.1 Contributors

Active Contributors:

We consider an active contributor in this project to be any contributor who has made at least 1 commit, opened at least 1 issue, created at least 1 pull request, or made more than 2 comments in the last month.

If there are more than 10 active contributors, the list is truncated to the top 10 based on contribution metrics for better clarity.

Access Last Week's Newsletter:

• Link