Weekly GitHub Report for Mermaid: April 28, 2025 - May 05, 2025 (12:00:12)
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: the addition of a Radar Chart, 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.
-
quadrant chart don't support \n: This issue is about a problem with the quadrant chart in a GitHub project, where the chart does not support line breaks (indicated by '\n') in the labels. The user has provided a code sample and steps to reproduce the issue, but no suggested solutions or additional context have been offered.
- A user commented with an image attachment, but no further details or solutions were provided in the comment.
- 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 representation in charts. - 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 a limitation not present in other graph types like QuadrantChartConfig. The user has resorted to using a Markdown title as a workaround and highlights that the title becomes very tiny when participants and interactions are added to the diagram.
- SVG rendering formatting issues with markdown input: This issue addresses formatting problems that occur when rendering SVG diagrams with markdown input in the Mermaid tool. Specifically, it highlights that additional height is added to nodes when opening the SVG in a new tab, and text is cut off when downloading the SVG, despite the node height remaining unchanged.
- 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 application startup, specifically when attempting to set properties on an undefined object, as indicated by the stack trace provided in the error message.
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: 6
Summarized Issues:
- Mermaid Documentation Issues: The Mermaid project documentation has inconsistencies and lacks clarity, particularly in the Class Diagram section where two different annotation syntaxes are presented without clear guidance. This can confuse users, necessitating an update to clarify the validity of both methods and recommend a consistent style.
- Mermaid Customization Requests: Users are seeking more customization options in Mermaid, such as the ability to import custom icon packs for Architecture diagrams, as existing options do not meet specific needs. Additionally, there is a request for a new diagram type to represent complex human relationships, which is currently unavailable.
- Mermaid Diagram Syntax Limitations: There are limitations in the current Mermaid diagram syntax, such as the inability to use colons in timeline diagrams, which affects the inclusion of timestamps. Another issue is the quadrant chart's lack of support for newline characters, impacting text display within quadrants.
- GitGraph Improvement Suggestion: An improvement has been proposed for GitGraphs to render branch names on the side of the last commit instead of the oldest commit. This change would better reflect the nature of git branches as pointers to the last commit in a series.
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:
- Mermaid sequence diagrams syntax issues: The issue with Mermaid sequence diagrams arises when an arrow without a label requires a colon followed by a whitespace to avoid syntax errors. This requirement conflicts with code hygiene practices that remove trailing whitespace, leading to a need for solutions to either eliminate the need for whitespace after the colon or make the colon optional for all arrows.
- Mermaid theming documentation clarity: The absence of clear documentation on customizing the fontFamily setting within the themeVariables of the Theming documentation page is a notable issue. It suggests adding an example to demonstrate how users can apply different fonts across diagrams, which would enhance user understanding and application.
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: 5
Key Open Pull Requests
1. Bug/6529 class static block syntax error: This pull request addresses a syntax error related to class static blocks by disabling the syntax, introduces a target option for customizable builds to resolve compatibility issues, and adds a build:vite script to produce smaller build sizes compared to esbuild, while also making adjustments to the build process to focus on specific packages and ensuring compatibility with the ms package's entry point.
- URL: pull/6561
- Merged: No
2. fix(gitGraph): honor showBranches config to hide branch lines and labels (#6535): This pull request addresses a bug in the Mermaid project by ensuring that the showBranches configuration in gitGraph is respected, thereby preventing branch lines and labels from rendering when they are set to be hidden, and includes updates to the rendering logic, necessary tests, and documentation.
- URL: pull/6554
- Merged: No
3. feat(docs): Add llms.txt file summary of the website docs URLs: This pull request introduces a new file, llms.txt, to the /docs directory of the Mermaid project, providing a structured, text-based summary of the documentation pages to facilitate context ingestion and navigation by Large Language Models (LLMs) and serve as a quick index for developers, without altering the existing code or website structure.
- URL: pull/6558
- Merged: No
Other Open Pull Requests
- Mermaid Class Diagram Documentation Updates: The pull requests focus on enhancing the Mermaid Class Diagram documentation by ensuring compliance with contribution guidelines and clarifying annotation syntax. One pull request updates the
classDiagram.mdfile to align with guidelines, add tests, and documentation, while another clarifies the annotation syntax, recommending the inline method for better readability and consistency, and includes examples and a Tip box.
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: 7
Key Closed Pull Requests
1. feat: Add vertical line to gantt plot at specified time: This pull request introduces a new feature to the Mermaid project by adding a "vert" tag that allows users to display a vertical line marker on a Gantt chart at a specified date, 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: 2025-04-29T06:43:03Z
- Associated Commits: d0ee6, ec2c7, 7e1ce, 8eb20, a4396, 5bbc9, 22037, 81fa2, 20091, 296cb, 167a6, 59a9e, 24470, f5c99
2. Fix font family docs: This pull request aims to clarify the Theming documentation by explaining that the fontFamily can be customized via themeVariables, while also addressing various issues related to pie chart title handling, such as title wrapping, font resizing, and positioning, as evidenced by multiple commits focused on improving these aspects.
- URL: pull/6543
- Merged: No
3. fix(sequenceDiagram): allow empty message after colon (Fixes #6518): This pull request addresses and resolves issue #6518 by modifying the lexer rule in the sequence diagram feature of the Mermaid project to allow arrows with a trailing colon but no message to parse correctly, changing the requirement from one or more characters after the colon to zero or more, thus enabling syntax like B ->> A: to be valid.
- URL: pull/6523
- Merged: 2025-04-28T06:42:42Z
Other Closed Pull Requests
- Theming Documentation Update: This topic involves updates to the Theming documentation to clarify customization options for
fontFamilyviathemeVariables. The changes also include fixing table formatting and correcting font size text, addressing issue #6542.
- UML Use-Case Diagrams Support: This topic covers the introduction of beta support for UML Use-Case diagrams in Mermaid. It includes a new grammar for actors and use-cases, a parser integrated with a database, an SVG renderer, a live-editor demo, a unit test suite, and comprehensive documentation.
- Vite Build Script Introduction: This topic addresses the introduction of a new Vite build script to replace esbuild, significantly reducing the output size and ensuring compatibility with iOS 15 Safari. The transformation to ES2018 syntax is specified in the project's TypeScript configuration, resolving compatibility issues and addressing issue #6529.
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 |
|---|---|---|---|---|
| jsoref | 105 | 0 | 5 | 2 |
| sidharthv96 | 34 | 3 | 1 | 8 |
| nourhenta | 13 | 3 | 3 | 1 |
| generrosity | 11 | 0 | 3 | 1 |
| CoyAce | 11 | 3 | 0 | 0 |
| thomascizeron | 11 | 1 | 0 | 0 |
| lrecknagel | 10 | 1 | 1 | 0 |
| No author found | 11 | 0 | 0 | 0 |
| monicanguyen25 | 10 | 1 | 0 | 0 |
| nour0205 | 1 | 3 | 2 | 3 |