mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-26 02:39:41 +02:00

Files

Sidharth Vinod ef428dc555 Merge branch 'neo-new-shapes' of https://github.com/Mermaid-Chart/alana-mermaid into sidv/configReturn

* 'neo-new-shapes' of https://github.com/Mermaid-Chart/alana-mermaid: (45 commits)
  updated styles, testcases and fixed html labels for image shape
  MC-1733 Reset layout
  updated ImageSqaure shape
  updated styles
  updated pos changes
  fixed html labels for icon shape
  updated test cases
  Added rounded icon shape
  Updated circle icon
  updated image shape
  Updated labels for shapes
  updated icon square and icon
  MC-1733 Reset layout
  Updated logic for vertex label
  Updated test cases
  Update .changeset/rude-meals-invite.md
  changesets
  added neo-fication and shape-resize for linedCylinder shape
  added neo-fication for curvedTrapezoid shape
  Version Packages
  ...

2024-09-12 15:19:21 +05:30

src

Merge branch 'neo-new-shapes' of https://github.com/Mermaid-Chart/alana-mermaid into sidv/configReturn

2024-09-12 15:19:21 +05:30

CHANGELOG.md

chore: Update changelogs

2024-09-02 21:04:34 +05:30

package.json

Merge from upstream

2024-09-03 11:55:46 +02:00

README.md

chore: Use spaces

2024-08-21 16:23:56 +05:30

tsconfig.json

feat: Remove direct file dependency of mermaid from elk, by using peerDependency.

2024-05-22 17:01:34 +05:30

README.md

@mermaid-js/layout-elk

This package provides a layout engine for Mermaid based on the ELK layout engine.

Note

The ELK Layout engine will not be available in all providers that support mermaid by default. The websites will have to install the @mermaid-js/layout-elk package to use the ELK layout engine.

Usage

flowchart-elk TD
  A --> B
  A --> C

---
config:
  layout: elk
---

flowchart TD
  A --> B
  A --> C

---
config:
  layout: elk.stress
---

flowchart TD
  A --> B
  A --> C

With bundlers

npm install @mermaid-js/layout-elk

import mermaid from 'mermaid';
import elkLayouts from '@mermaid-js/layout-elk';

mermaid.registerLayoutLoaders(elkLayouts);

With CDN

<script type="module">
  import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
  import elkLayouts from 'https://cdn.jsdelivr.net/npm/@mermaid-js/layout-elk@11/dist/mermaid-layout-elk.esm.min.mjs';

  mermaid.registerLayoutLoaders(elkLayouts);
</script>

Supported layouts

elk: The default layout, which is elk.layered.
elk.layered: Layered layout
elk.stress: Stress layout
elk.force: Force layout
elk.mrtree: Multi-root tree layout
elk.sporeOverlap: Spore overlap layout