Weekly GitHub Report for Mermaid: April 07, 2025 - April 14, 2025 (14:09:43)
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:
The current version of this repository is @mermaid-js/parser@0.4.0
1.2 Version Information:
On March 25, 2025, a minor update was released for the Mermaid project, introducing a new feature that adds support for Radar Charts, thanks to the contribution from @thomascizeron.
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.
-
mermaid.render renders classDiagrams with viewBox="-820 -820 3116 2828" style="max-width: 3116px;" irrespective of config: This issue is about a problem with the
mermaid.renderfunction, which is rendering class diagrams with a specificviewBoxandmax-widthstyle that causes inconsistencies, such as diagrams being shifted outside the SVG bounds and having tiny fonts. The user is seeking a solution to render these diagrams consistently when converting markdown to docx, as some diagrams are not displaying correctly.- The user provided a screenshot showing the expected output from the
mermaid.render()function, indicating that the current rendering does not match the desired result as seen in the playground. - Number of comments this week: 1
- The user provided a screenshot showing the expected output from the
-
Unnecessary crossing of edges between nodes: This issue highlights a problem with the Mermaid engine, where diagrams are generated with unnecessary line crossings between nodes, specifically below the boxes labeled "Four" and "Five." The issue suggests that these crossings could be eliminated by simply swapping the endpoints of certain lines, which would improve the clarity of the diagrams.
- A comment suggests that the problem is not unique and may be related to the layout engine, indicating a broader issue with how the engine handles node connections.
- Number of comments this week: 1
Since there were fewer than 5 open issues, all of the open issues have been listed above.
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.
- Tooltips for emoji in Diagram Syntax doc tree: This issue addresses the lack of clarity in the "Diagram Syntax" section of the documentation tree, where emojis are used next to diagram type names without any explanation of their meanings. The proposal suggests adding tooltips to these emojis to help users understand the information they are intended to convey, enhancing the usability and comprehension of the documentation.
- log scale for
xychart-beta: This issue proposes the addition of a string field namedscaleto thexychart-betafeature, which would default tolinearbut also acceptlogas an option, allowing for future extensions to other scales. The implementation of this feature would enable users to maintain version control of graph descriptions with true values while plotting the logged values, enhancing the flexibility and accuracy of data visualization. - Unable to Style Sequence Diagram Title: This issue pertains to the inability to modify the font size of the title in a sequence diagram created using Mermaid, which is causing the title to become very small when additional participants and interactions are added. The user notes that while other graph types in Mermaid have configurable title attributes, such as those in QuadrantChartConfig, this feature is not yet available for sequence diagrams, leading them to use a Markdown title as a workaround.
- SVG rendering formatting issues with markdown input: This issue addresses formatting problems that occur when rendering SVG diagrams with markdown input in the Mermaid live editor. Specifically, it highlights two main problems: additional height being added to nodes when opening the SVG in a new tab, and text being cut off when downloading the SVG, both of which affect the visual output of the diagrams.
- Vite build error with mermaid version 10.9.0: This issue involves a build error encountered when using Mermaid version 10.9.0 in a Vue 3 + Vite application, where the developer successfully views graphs during development but encounters a "TypeError: Cannot set properties of undefined" upon building the project. The error seems to occur during the initialization of the Mermaid API, specifically when attempting to set the 'prototype' property, and the developer is seeking support to resolve this issue.
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: 7
Summarized Issues:
- Plugin Conflicts and Rendering Issues: The mkdocs-mermaid2-plugin is causing conflicts with KaTeX formulas by altering the HTML document type, leading to improper rendering due to quirks mode. Additionally, the
mermaid.renderfunction is experiencing issues with class diagrams, where fixedviewBoxandmax-widthstyles result in diagrams being shifted and having tiny fonts.
- Diagram Customization and Bugs: There is a proposal to add custom labels for radar chart ticks in the Mermaid project, allowing users to specify labels and their placement. Meanwhile, a bug in the tool is causing the WSL node in block diagrams to not display at the intended width, and unnecessary line crossings are occurring between nodes in generated diagrams.
- Feature Requests for Diagram Enhancements: A request has been made to add a Chevron shape to Flowchart or Block Diagrams, emphasizing its common use in process diagrams. Additionally, there is a proposal to support rendering
codespanelements in a monospace font to improve the display of inline code snippets.
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:
- Flowchart Syntax Errors in Mermaid Documentation: The Flowchart documentation page of the Mermaid library has issues with previews not rendering correctly due to syntax errors in version 11.6.0. Incorrect flowchart syntax, such as
e1@->instead ofe1@-->, leads to parsing and console errors, which have been addressed with a pull request for correction.
- Sequence Diagram Participant Alias Limitation: Users face difficulties when adding a participant with an alias into a box within a sequence diagram using Mermaid. The documentation does not clarify this limitation, leading users to seek guidance on whether they are missing something in their approach.
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: 4
Key Open Pull Requests
1. feat: Add vertical line to gantt plot at specified time: This pull request introduces a new feature to the Gantt chart functionality by adding a "vert" tag, which allows users to display a vertical line marker at a specified date on the chart, similar to the "milestone" tag, to highlight significant points in time, with the line and its label rendered in a fixed navy color for distinction.
- URL: pull/6479
- Merged: No
- Associated Commits: 1125f, 2bc3a, a401a, e8986, 35054, 4fff6, c1db4, 8627f, c8e87, c28c0, d0ee6, ec2c7, 7e1ce, 8eb20, a4396, 5bbc9, 22037, 81fa2, 20091, 296cb, 167a6, 59a9e, 24470, f5c99
2. feat: Dynamically Render Data Labels Within Bar Charts: This pull request introduces a configurable option called showDataLabel within the xyChart component to dynamically render data labels inside bar charts, ensuring that labels adjust their font size and positioning to remain visible within each bar, accommodate various bar sizes and orientations, and prevent text overflow, while also filtering out zero-sized bars and applying a uniform font size for visual consistency.
- URL: pull/6475
- Merged: No
- Associated Commits: 34e75, 99a2d, 17fcf, f2f2a, ad6f8, 6a538, f4c08, 2798e, 8bdd7, 73f8d, 8b7a4, a2bf5, dff00, b00be, 6957f, f69cc
3. feat(flowchart): add inheritDir option for subgraph direction: This pull request introduces a new configuration option called inheritDir for flowcharts, allowing subgraphs to optionally inherit the global direction of the parent flowchart, thereby enabling a consistent layout direction across all levels when set to true, while maintaining the existing alternating direction behavior by default for optimal layout efficiency.
- URL: pull/6470
- Merged: No
Other Open Pull Requests
- Pie Chart Title Rendering: This pull request addresses the issue of pie chart titles being cropped by implementing a dynamic font size reduction mechanism. It measures the title width using
getBBox()and iteratively decreases the font size until the title fits within the available space, ensuring proper rendering without runtime errors.
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: 6
Key Closed Pull Requests
1. Fix: greedy regex in common langium: This pull request refactors the common Langium grammar by reorganizing terminal definitions to separate greedy terminals into distinct files, thereby fixing terminal order issues, removing redundant code through imports, and adding tests to ensure that architecture diagrams are not broken by title keywords, ultimately resolving issue #6162.
- URL: pull/6407
- Merged: 2025-04-08T11:46:22Z
2. fix(docs): fix edge ID example: This pull request addresses a documentation issue in the Flowchart section of the Mermaid project by correcting a rendering error caused by a Unicode en dash being used instead of an ASCII dash in the edge syntax, ensuring the proper use of the id@--> syntax for assigning IDs to edges, and maintaining the intended behavior without altering functionality or implementation.
- URL: pull/6456
- Merged: 2025-04-10T07:23:06Z
3. build: fix mermaid-zenuml IIFE build and add changesets: This pull request addresses the issue with the mermaid-zenuml IIFE build by updating ESBuild scripts to support multiple IIFE bundles, adds changeset entries for specific commits to prepare for the v0.2.1 release, and resolves a problem related to the migration from Vite to ESBuild, ensuring compatibility and avoiding conflicts with older versions of Mermaid.
- URL: pull/6465
- Merged: 2025-04-09T08:42:37Z
Other Closed Pull Requests
- Removal of duplicate entries in integrations-community.md: This pull request focuses on cleaning up the
integrations-community.mdfile by removing duplicate entries. The changes were successfully merged, ensuring the document is more concise and accurate.
- Bug fix for incorrect SVG output in diagrams: A bug in the Mermaid project caused some diagrams to incorrectly output
style="undefined;"in their SVG files. This pull request addresses the issue, particularly within.edgePaths, ensuring diagrams render correctly.
- Script for comparing end-to-end test timings: This pull request introduces a script to compare new end-to-end test timings with previous ones. It ensures timing updates are made only when there are significant changes, preventing unnecessary updates when test performance remains stable.
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.
| Contributor | Commits | Pull Requests | Issues | Comments |
|---|---|---|---|---|
| BambioGaming | 24 | 4 | 0 | 6 |
| Shahir-47 | 25 | 1 | 0 | 0 |
| lgazo | 24 | 1 | 0 | 0 |
| nourhenta | 6 | 3 | 4 | 4 |
| thomascizeron | 16 | 1 | 0 | 0 |
| sidharthv96 | 15 | 2 | 0 | 0 |
| nour0205 | 2 | 5 | 3 | 6 |
| monicanguyen25 | 14 | 1 | 0 | 0 |
| No author found | 11 | 0 | 0 | 0 |
| ashishjain0512 | 10 | 0 | 0 | 1 |
Access Last Week's Newsletter: