mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-03 20:34:20 +01:00 
			
		
		
		
	Merge branch 'develop' into sidv/examples
* develop: docs: improve elk section of ER docs Fix formatting of ELK example in ERD + clarify usage
This commit is contained in:
		@@ -625,17 +625,43 @@ erDiagram
 | 
			
		||||
 | 
			
		||||
## Configuration
 | 
			
		||||
 | 
			
		||||
### Renderer
 | 
			
		||||
### Layout
 | 
			
		||||
 | 
			
		||||
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#customizing-elk-layout).
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
---
 | 
			
		||||
config:
 | 
			
		||||
  layout: elk
 | 
			
		||||
---
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Your Mermaid code should be similar to the following:
 | 
			
		||||
 | 
			
		||||
```mermaid-example
 | 
			
		||||
---
 | 
			
		||||
    config:
 | 
			
		||||
        layout: elk
 | 
			
		||||
title: Order example
 | 
			
		||||
config:
 | 
			
		||||
    layout: elk
 | 
			
		||||
---
 | 
			
		||||
erDiagram
 | 
			
		||||
    CUSTOMER ||--o{ ORDER : places
 | 
			
		||||
    ORDER ||--|{ LINE-ITEM : contains
 | 
			
		||||
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```mermaid
 | 
			
		||||
---
 | 
			
		||||
title: Order example
 | 
			
		||||
config:
 | 
			
		||||
    layout: elk
 | 
			
		||||
---
 | 
			
		||||
erDiagram
 | 
			
		||||
    CUSTOMER ||--o{ ORDER : places
 | 
			
		||||
    ORDER ||--|{ LINE-ITEM : contains
 | 
			
		||||
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
> **Note**
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user