From 0104d19f6602800d18f3759bb0d0164bf4d750be Mon Sep 17 00:00:00 2001
From: isaiah robinson <95643215+internetisaiah@users.noreply.github.com>
Date: Thu, 27 Mar 2025 15:47:43 -0700
Subject: [PATCH] Fix formatting of ELK example in ERD + clarify usage

---
 .../docs/syntax/entityRelationshipDiagram.md  | 24 +++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)

diff --git a/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md b/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md
index 46fb7ee86..cb0db0844 100644
--- a/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md
+++ b/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md
@@ -409,17 +409,33 @@ erDiagram
 
 ### Renderer
 
-The layout of the diagram is done with the renderer. The default renderer is dagre.
+The layout of the diagram is handled by [`render()`](../config/setup/mermaid/interfaces/Mermaid.md#render). The default layout is dagre.
 
-You can opt to use an alternate renderer named elk by editing the configuration. The elk renderer is better for larger and/or more complex diagrams.
+For larger or more-complex diagrams, you can alternatively apply the ELK (Eclipse Layout Kernel) layout using your YAML frontmatter's `config`. For more information, see [Customizing ELK Layout](../intro/syntax-reference.md).
 
 ```
 ---
-    config:
-        layout: elk
+config:
+    layout: elk
 ---
 ```
 
+Your Mermaid code should be similar to the following:
+
+``````mermaid-example
+```mermaid
+---
+title: Order example
+config:
+    layout: elk
+---
+erDiagram
+    CUSTOMER ||--o{ ORDER : places
+    ORDER ||--|{ LINE-ITEM : contains
+    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
+```
+``````
+
 ```note
 Note that the site needs to use mermaid version 9.4+ for this to work and have this featured enabled in the lazy-loading configuration.
 ```