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. [STATUS: TRIAGE] eventmodeling: re-entering a namespace creates a duplicate swimlane: This issue describes a problem in the event modeling feature where re-entering a namespace in a timeline incorrectly creates duplicate swimlanes instead of reusing the existing one, leading to an inflated number of swimlanes in diagrams. This behavior disrupts realistic Event Modeling flows where control returns to a previously used namespace after another namespace has appeared, causing confusion and inaccuracies in the visual representation.

   • The comments identify the root cause as swimlanes not storing their namespace, causing lookups to fail and duplicate lanes to be created; a fix was implemented to store and match namespaces correctly within bands, and a test was added to verify the correction, with appreciation expressed for the detailed reproduction steps provided.
   • Number of comments this week: 2

2. [TYPE: BUG / ERROR] [STATUS: TRIAGE] Subgraph direction and limitation: This issue reports unexpected behavior in the rendering and documentation of subgraphs, specifically that edges directed to a node inside a subgraph incorrectly point to the subgraph itself, and that subgraphs do not inherit the top-level graph's left-to-right direction as expected. The user highlights that this problem was not present in previous versions of the documentation and provides screenshots and browser details to support the observation.

   • The comments identify a related duplicate issue and suggest that removing the direction attribute from subgraphs may resolve the bug; it is noted that the problem appears fixed in version 11.14.0 but a breaking change in version 11.16 reintroduced it, and the SVG rendering in the documentation has not yet been updated to reflect the fix.
   • Number of comments this week: 2

3. [CONTRIBUTOR NEEDED] [STATUS: PENDING] [STATUS: TRIAGE] [TYPE: NEW DIAGRAM] [REQUIRED GROOMING] Quantum Circuit Diagram Support: This issue requests the addition of support for quantum circuit diagrams in Mermaid, aiming to provide a more flexible and markdown-friendly way to represent quantum algorithms compared to the current LaTeX quantikz package. The proposal includes generating quantum circuit primitives such as qubits, qubit lines, gates, and measurements to visually depict quantum states and operations within Mermaid diagrams.

   • The comments express enthusiasm for the feature and seek further input on the specification from contributors, indicating ongoing interest and collaboration on the development of this functionality.
   • Number of comments this week: 1

4. [TYPE: ENHANCEMENT] [TYPE: NEW DIAGRAM] BPMN support: This issue requests the addition of BPMN (Business Process Model and Notation) support in Mermaid to enable users to create and manage business process diagrams directly within Mermaid, especially benefiting integrations like Notion. The discussion focuses on scoping the feature to primarily cover Level 1 BPMN elements for practical documentation and communication use, with community input on which BPMN components are most essential and suggestions for future expansions.

   • The comments include sharing of existing BPMN tools and DSLs, strong community support for starting with Level 1 BPMN elements, detailed use cases emphasizing documentation and communication over execution, and offers of example diagrams and prototypes; maintainers seek user input to define a realistic scope before implementation begins.
   • Number of comments this week: 1

5. [TYPE: ENHANCEMENT] [STATUS: TRIAGE] [TYPE: NEW DIAGRAM] [FEAT] Graphviz support inside Mermaid: This issue requests adding Graphviz support inside Mermaid to enable websites and applications that use Mermaid to also support Graphviz diagrams seamlessly, facilitating an easy transition from native Graphviz syntax to Mermaid. The feature aims to avoid duplicating efforts by integrating Graphviz capabilities directly rather than requiring separate native Graphviz or viz.js support.

   • The comments express positive reception of the idea and provide a relevant solution involving a pure-TypeScript port of Graphviz that runs in the browser without WASM, offering a lightweight and validated alternative to traditional Graphviz implementations, with an offer to assist in exploring integration possibilities.
   • 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: 4

Summarized Issues:

• Diagram Customization and Layout Issues: Several issues highlight problems with diagram rendering and customization in Mermaid. One issue requests enhanced control over label positioning and padding in block diagrams to improve visual realism, while another reports that subgraph direction behavior does not work as documented, causing links to stop at subgraph borders unexpectedly.
• [issues/7981, issues/8002]

• Dependency Update Requests: There is a request to update the marked package to version 18, referencing relevant release notes and the current package.json location to keep dependencies current and secure.
• [issues/7987]

• Character Encoding and Parsing Errors: An issue reports that the sankey chart does not support Chinese characters, resulting in a parsing error with a specific message indicating unexpected text input, which limits the chart's usability with non-Latin scripts.
• [issues/7996]

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: 3

Summarized Issues:

• Documentation updates and syntax changes: This topic covers the removal of deprecated directive syntax from Mermaid documentation examples and replacing them with YAML frontmatter configuration. The directives page is retained as a reference for older versions to maintain backward compatibility.
• issues/4756

• Diagram type naming and consistency: This issue involves correcting the incorrect diagram name railroad-beta in demos to railroad-ebnf-beta to align with the live editor and recent updates. Ensuring consistent naming helps avoid confusion and reflects the current state of the software.
• issues/7979

• Character encoding and parser regex limitations: This topic addresses the problem in the architecture-beta diagram type where bracket labels reject non-ASCII characters due to a restrictive regex in the parser. The proposed fix modifies the regex to accept any characters except square brackets, preventing lexer errors and allowing a wider range of characters in labels.
• issues/7961

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: Add ELK force and stress algorithm support: This pull request implements support for two new ELK layout algorithms—force-directed (elk.force) with EADES and FRUCHTERMAN_REINGOLD physics models, and stress-minimization (elk.stress)—in the mermaid-layout-elk package, including configurable options, algorithm detection helpers, comprehensive testing, updated documentation, and interactive demo pages showcasing these algorithms.

• URL: pull/7983

• Associated Commits: ecc96, 85125, f4e8a, 1047e, f8aa0, d949b, 8fdb8, 44aa6, 6c920, d0064, 959b0, 79222, a14d7, a2089, b465d, 5c356, 12018, 30828, 892dc, 9dddf, 63953, 09cc5, 5c010, f17bd, 11a52, 47528, ecfcd, 1f2d0

2. feat(c4): render elements in the c4model.com outline style: This pull request implements the rendering of C4 model elements using the c4model.com outline style, featuring a light fill with the element's identity color applied to borders and text, while preserving existing color configurations and enhancing label rendering, shape reuse, sizing, and performance as part of the C4 modernization effort.

• URL: pull/7991

• Associated Commits: b06b7, f9324, 77158, c0a66, 34bfa, 2e3f5, 22a10, 021b4, 660df, f56cf, 81e94, a6b7e, d635b, 0b728, 62cc9, b3756, 16681, 795e9, c7640, 1233b, 0bfc2, c72e5, 99433, caef7

3. Chore/7987 update marked to v18: This pull request upgrades the marked markdown rendering library in the packages/mermaid package to version 18.0.6, updates the Node.js version to 24.16.0, fixes the validate-lockfile GitHub Action workflow by allowing unsafe pull request checkouts, excludes certain unreliable external links from the link checker, and ensures all related tests pass successfully.

• URL: pull/7990

• Associated Commits: 16879, 6aa98, 91b4b, 5a482, 52650, ba806

Other Open Pull Requests

• Continuous Integration Workflow Improvements: This set of pull requests updates the CI workflow by switching from pull_request_target to pull_request to fix errors with fork checkouts, pins the actions/checkout version to avoid breaking changes, and uses a blobless clone with a smaller runner for efficiency. It also replaces PR comment reporting with GitHub Actions step summaries and simplifies shell expressions to improve security and maintainability.
• pull/8003, pull/7980

• Flowchart Interaction and Rendering Enhancements: These pull requests add support for the click directive on flowchart subgraphs by extending interaction handling and updating cluster label rendering to include clickable links with sandbox security. They also fix rendering issues with dashed strokes on stadium flowchart nodes by replacing rough.js segments with a single SVG path to correctly apply stroke styles while preserving hand-drawn effects.
• pull/7988, pull/7992

• Subgraph and Layout Fixes: This pull request fixes handling of leaf edges in explicitly directed subgraphs by ensuring simple leaf-edge cases remain in the parent graph to preserve layout constraints and alignment, resolving issue #7954 with updated logic and tests.
• pull/7993

• New Diagram Types and Integrations: These pull requests introduce a new quantumCircuit-beta diagram type as a proof-of-concept for visualizing quantum circuits and add a basic custom widget for Grist to display document structures with an entity relationship diagram, updating the community productivity tool integration documentation accordingly.
• pull/7994, pull/7995

• Parser and Lexer Improvements: This pull request fixes the Sankey diagram parser to allow non-ASCII characters, such as Chinese, in unquoted node names by extending the lexer’s TEXTDATA token to accept Unicode BMP characters while excluding delimiters and control characters, resolving lexer errors and adding tests for correct parsing.
• pull/7998

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: 3

Key Closed Pull Requests

1. docs: replace remaining directive examples with frontmatter: This pull request updates the architecture and Cynefin documentation examples by replacing deprecated %%{init}%% directive snippets with YAML frontmatter configuration blocks, while preserving reference files for older Mermaid versions and ensuring consistency across the docs.

• URL: pull/7989

• Associated Commits: b775d, de3e8

• Associated Commits: b775d, de3e8

2. fix(architecture): allow non-ASCII characters and punctuation in unqu…: This pull request fixes the architecture-beta diagram parser by updating the ARCH_TITLE terminal to allow non-ASCII characters and common punctuation in unquoted bracket titles, resolving lexer errors caused by the previous ASCII-only \w character class, while preserving existing quoted-title syntax and adding comprehensive tests for various Unicode scripts.

• URL: pull/7984

• Associated Commits: e8484

• Associated Commits: e8484

3. fix(railroad): correct EBNF demo keywords: This pull request corrects all eight EBNF examples in the demos/railroad.html file by replacing the outdated railroad-beta diagram keyword with the registered railroad-ebnf-beta keyword, ensuring accurate demo rendering without requiring changes to parsers, detectors, dependencies, or documentation.

• URL: pull/7985

• Associated Commits: 73ef2

• Associated Commits: 73ef2

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