enable elk renderer for embedded mermaid charts

[moui72]

Select Topic Area

Question

Body

Any chance we can get support for the elk layout engine for mermaid charts?

https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid-layout-elk

With a complex chart, it looks pretty confusing with the default renderer

flowchart
 subgraph api-demographics["api-demographics"]
        D[("Database")]
        ABC["some-service<br><small><em>ABC on DEF</em></small>"]
        R[["Dying Service<br><small><em>Deprecated Soon</em></small>"]]
        W["Another Service"]
  end
  subgraph something
        F["something"]
        L[("Destination")] 
  end
    P[["Source"]]
    E["something-else<br><small><em>Deprecated Eventually</em></small>"]
    F["even-more-things<br><small><em>Dependency Eliminated Eventually</em></small>"]
    G["whatever"]
    H["another thing"]
    J{{"Secrets"}}
    K[("Potato")]
    ABC -.-> R -.-> D
    ABC -.-> F & E
    ABC == Build time dependency ==> J
    ABC --> D & L & Fa & G & H
    P --> W
    W --> D & L & Fa & J & K
    style R stroke:#666,fill:#EEE
    style F stroke:#660,fill:#FFC
    style E stroke:#660,fill:#FFC
    style W stroke:blue,fill:#CCF
    style ABC stroke: green, fill: #CFC
    linkStyle default stroke:green
    linkStyle 10,11,12,13,14,15 stroke:blue,color:blue

Loading

You can see it's rendered the same on GH at the time of writing this, even if I try to switch the renderer via the using flowchart-elk chart type, because github has not installed @mermaid-js/layout-elk

flowchart-elk
 subgraph api-demographics["api-demographics"]
        D[("Database")]
        ABC["some-service<br><small><em>ABC on DEF</em></small>"]
        R[["Dying Service<br><small><em>Deprecated Soon</em></small>"]]
        W["Another Service"]
  end
  subgraph something
        F["something"]
        L[("Destination")] 
  end
    P[["Source"]]
    E["something-else<br><small><em>Deprecated Eventually</em></small>"]
    F["even-more-things<br><small><em>Dependency Eliminated Eventually</em></small>"]
    G["whatever"]
    H["another thing"]
    J{{"Secrets"}}
    K[("Potato")]
    ABC -.-> R -.-> D
    ABC -.-> F & E
    ABC == Build time dependency ==> J
    ABC --> D & L & Fa & G & H
    P --> W
    W --> D & L & Fa & J & K
    style R stroke:#666,fill:#EEE
    style F stroke:#660,fill:#FFC
    style E stroke:#660,fill:#FFC
    style W stroke:blue,fill:#CCF
    style ABC stroke: green, fill: #CFC
    linkStyle default stroke:green
    linkStyle 10,11,12,13,14,15 stroke:blue,color:blue

Loading

Here's what it looks like when I render it using elk on www.mermaidchart.com

[kpietraszko]

I'm surprised this isn't supported. ELK is often much more readable, not just in complex nested diagrams and edge-cases.

[ferdef]

Any chance this is going to be added? It's confusing that ELK is supported from the Visual Studio Mermaid plugin, but once you push the changes the diagram looks completely different in Github

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐