From 0e3dadc53c7b5eaab52753515186e01210488dc2 Mon Sep 17 00:00:00 2001 From: Knut Sveidqvist Date: Wed, 11 Jan 2023 17:58:05 +0100 Subject: [PATCH] Updated as per the suggestions from @weedySeaDragon --- docs/syntax/flowchart.md | 7 +++++-- packages/mermaid/src/docs/syntax/flowchart.md | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/syntax/flowchart.md b/docs/syntax/flowchart.md index fa410623d..0ef94d24b 100644 --- a/docs/syntax/flowchart.md +++ b/docs/syntax/flowchart.md @@ -994,9 +994,12 @@ flowchart LR ### Renderer -The layout of the flowchart diagram can be don in multiple ways. The default rendering is done using an algorithm called dagre. It is possible to use another algorithm called **elk** for rendering flowcharts which is better for large and more complex diagrams. This is an expermental feature but worth exploring. +The layout of the diagram is done with the renderer. The default renderer is dagre. -This can be enabled using directives by adding this in the diagram code: +Starting with Mermaid version 9.4, you can use an alternate renderer named elk. The elk renderer is better for larger and/or more complex diagrams. + +The _elk_ renderer is an experimenal feature. +You can change the renderer to elk by adding this directive: %%{init: {"flowchart": {"defaultRenderer": "elk"}} }%% diff --git a/packages/mermaid/src/docs/syntax/flowchart.md b/packages/mermaid/src/docs/syntax/flowchart.md index a66f795b7..9a0e7bc24 100644 --- a/packages/mermaid/src/docs/syntax/flowchart.md +++ b/packages/mermaid/src/docs/syntax/flowchart.md @@ -673,9 +673,12 @@ flowchart LR ### Renderer -The layout of the flowchart diagram can be don in multiple ways. The default rendering is done using an algorithm called dagre. It is possible to use another algorithm called **elk** for rendering flowcharts which is better for large and more complex diagrams. This is an expermental feature but worth exploring. +The layout of the diagram is done with the renderer. The default renderer is dagre. -This can be enabled using directives by adding this in the diagram code: +Starting with Mermaid version 9.4, you can use an alternate renderer named elk. The elk renderer is better for larger and/or more complex diagrams. + +The _elk_ renderer is an experimenal feature. +You can change the renderer to elk by adding this directive: ``` %%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%