Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README not rendering class diagram #4647

Closed
tomperr opened this issue Jul 18, 2023 · 1 comment · Fixed by #4780
Closed

README not rendering class diagram #4647

tomperr opened this issue Jul 18, 2023 · 1 comment · Fixed by #4780
Assignees
Labels
Graph: Class Status: Approved Is ready to be worked on Status: Awaiting PR Type: Bug / Error Something isn't working or is incorrect

Comments

@tomperr
Copy link
Contributor

tomperr commented Jul 18, 2023

Description

When I read the README on the mermaid repo, the class diagram does not render

Steps to reproduce

Go to the homepage of the repo and look at the README
Also, directly taking a look at the README.md file triggers the error

Screenshots

image

Code Sample

No response

Setup

  • Mermaid version: The one used by Github
  • Browser and Version: Firefox 115.0.2

Suggested Solutions

No response

Additional Context

The diagram renders correctly on the mermaid live editor.
I could not check right not, but might it be a mermaid version error? If the class diagram requires mermaid 10.2.0 version or later and Github uses mermaid 10.1.0 (I took random version numbers for this example), an error would be triggered

@tomperr tomperr added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Jul 18, 2023
@sidharthv96
Copy link
Member

sidharthv96 commented Jul 18, 2023

GitHub uses

info
Loading

If there is an unsupported feature in the diagram, maybe we could remove it from the main readme till github updates mermaid.

@jgreywolf jgreywolf self-assigned this Aug 27, 2023
@jgreywolf jgreywolf added Status: Approved Is ready to be worked on Graph: Class Status: Awaiting PR and removed Status: Triage Needs to be verified, categorized, etc labels Aug 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Graph: Class Status: Approved Is ready to be worked on Status: Awaiting PR Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants