Skip to content

docs: document ELK layout registration for flowcharts#7900

Open
AgnetaGavrielov wants to merge 2 commits into
mermaid-js:developfrom
AgnetaGavrielov:docs/5969-elk-renderer-registration
Open

docs: document ELK layout registration for flowcharts#7900
AgnetaGavrielov wants to merge 2 commits into
mermaid-js:developfrom
AgnetaGavrielov:docs/5969-elk-renderer-registration

Conversation

@AgnetaGavrielov

Copy link
Copy Markdown

Summary

  • documents how to install and register @mermaid-js/layout-elk when using Mermaid outside the Live Editor
  • adds bundler and CDN examples using mermaid.registerLayoutLoaders
  • clarifies that ELK can then be selected with flowchart.defaultRenderer or layout: elk

Fixes #5969

Checklist

  • Documentation only
  • Tests are not needed for this documentation-only change
@changeset-bot

changeset-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8117f72

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify

netlify Bot commented Jun 20, 2026

Copy link
Copy Markdown

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 8117f72
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/6a37206cc2b33c000813ee7f
😎 Deploy Preview https://deploy-preview-7900--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@pkg-pr-new

pkg-pr-new Bot commented Jun 20, 2026

Copy link
Copy Markdown

Open in StackBlitz

@mermaid-js/examples

npm i https://pkg.pr.new/@mermaid-js/examples@7900

mermaid

npm i https://pkg.pr.new/mermaid@7900

@mermaid-js/layout-elk

npm i https://pkg.pr.new/@mermaid-js/layout-elk@7900

@mermaid-js/layout-tidy-tree

npm i https://pkg.pr.new/@mermaid-js/layout-tidy-tree@7900

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/@mermaid-js/mermaid-zenuml@7900

@mermaid-js/parser

npm i https://pkg.pr.new/@mermaid-js/parser@7900

@mermaid-js/tiny

npm i https://pkg.pr.new/@mermaid-js/tiny@7900

commit: 8117f72

@codecov

codecov Bot commented Jun 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 24.36%. Comparing base (6a6a562) to head (8117f72).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #7900       +/-   ##
============================================
- Coverage    67.79%   24.36%   -43.44%     
============================================
  Files          429       30      -399     
  Lines        38648     6925    -31723     
  Branches      6364      337     -6027     
============================================
- Hits         26201     1687    -24514     
+ Misses        9675     5238     -4437     
+ Partials      2772        0     -2772     
Flag Coverage Δ
e2e ?
unit 24.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 423 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
@AgnetaGavrielov AgnetaGavrielov force-pushed the docs/5969-elk-renderer-registration branch from fd07b4d to 037c33d Compare June 20, 2026 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

1 participant