mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-11 03:19:42 +02:00
Updated theming docs
This commit is contained in:
161
docs/theming.md
161
docs/theming.md
@@ -32,8 +32,7 @@ When Generating a diagram using on a webpage that supports mermaid. It is also p
|
|||||||
|
|
||||||
Here is an example of how `%%init%%` can set the theme to 'base', this assumes that `themeVariables` are set to default:
|
Here is an example of how `%%init%%` can set the theme to 'base', this assumes that `themeVariables` are set to default:
|
||||||
|
|
||||||
```
|
```mermaid
|
||||||
mermaid
|
|
||||||
%%{init: {'theme':'base'}}%%
|
%%{init: {'theme':'base'}}%%
|
||||||
graph TD
|
graph TD
|
||||||
A[Christmas] -->|Get money| B(Go shopping)
|
A[Christmas] -->|Get money| B(Go shopping)
|
||||||
@@ -80,6 +79,24 @@ The easiest way to make a custom theme is to start with the base theme, and just
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#00ff00'}}}%%
|
||||||
|
graph TD
|
||||||
|
A[Christmas] -->|Get money| B(Go shopping)
|
||||||
|
B --> C{Let me think}
|
||||||
|
B --> G[/Another/]
|
||||||
|
C ==>|One| D[Laptop]
|
||||||
|
C -->|Two| E[iPhone]
|
||||||
|
C -->|Three| F[fa:fa-car Car]
|
||||||
|
subgraph section
|
||||||
|
C
|
||||||
|
D
|
||||||
|
E
|
||||||
|
F
|
||||||
|
G
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
**Notes:
|
**Notes:
|
||||||
Leaving it empty will set all variable values to default.
|
Leaving it empty will set all variable values to default.
|
||||||
@@ -202,6 +219,25 @@ You can create your own themes, by changing any of the given variables below. If
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
|
||||||
|
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ff0000'}}}%%
|
||||||
|
graph TD
|
||||||
|
A[Christmas] -->|Get money| B(Go shopping)
|
||||||
|
B --> C{Let me think}
|
||||||
|
B --> G[/Another/]
|
||||||
|
C ==>|One| D[Laptop]
|
||||||
|
C -->|Two| E[iPhone]
|
||||||
|
C -->|Three| F[fa:fa-car Car]
|
||||||
|
subgraph section
|
||||||
|
C
|
||||||
|
D
|
||||||
|
E
|
||||||
|
F
|
||||||
|
G
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
**This got a bit too dark and bit too colorful. With some easy steps this can be fixed:
|
**This got a bit too dark and bit too colorful. With some easy steps this can be fixed:
|
||||||
|
|
||||||
* Make the primary color a little lighter
|
* Make the primary color a little lighter
|
||||||
@@ -227,8 +263,7 @@ You can create your own themes, by changing any of the given variables below. If
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```mermaid
|
||||||
mermaid
|
|
||||||
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%%
|
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%%
|
||||||
graph TD
|
graph TD
|
||||||
A[Christmas] -->|Get money| B(Go shopping)
|
A[Christmas] -->|Get money| B(Go shopping)
|
||||||
@@ -315,8 +350,7 @@ mermaid
|
|||||||
|
|
||||||
### Sequence diagram
|
### Sequence diagram
|
||||||
|
|
||||||
```
|
```mermaid
|
||||||
mermaid
|
|
||||||
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
||||||
|
|
||||||
sequenceDiagram
|
sequenceDiagram
|
||||||
@@ -366,9 +400,37 @@ classDiagram
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Gantt
|
### Gantt
|
||||||
|
|
||||||
```
|
```
|
||||||
mermaid
|
gantt
|
||||||
|
dateFormat :YYYY-MM-DD
|
||||||
|
title Adding GANTT diagram functionality to mermaid
|
||||||
|
excludes :excludes the named dates/days from being included in a charted task..
|
||||||
|
section A section
|
||||||
|
Completed task :done, des1, 2014-01-06,2014-01-08
|
||||||
|
Active task :active, des2, 2014-01-09, 3d
|
||||||
|
Future task : des3, after des2, 5d
|
||||||
|
Future task2 : des4, after des3, 5d
|
||||||
|
|
||||||
|
section Critical tasks
|
||||||
|
Completed task in the critical line :crit, done, 2014-01-06,24h
|
||||||
|
Implement parser and jison :crit, done, after des1, 2d
|
||||||
|
Create tests for parser :crit, active, 3d
|
||||||
|
Future task in critical line :crit, 5d
|
||||||
|
Create tests for renderer :2d
|
||||||
|
Add to mermaid :1d
|
||||||
|
|
||||||
|
section Documentation
|
||||||
|
Describe gantt syntax :active, a1, after des1, 3d
|
||||||
|
Add gantt diagram to demo page :after a1 , 20h
|
||||||
|
Add another diagram to demo page :doc1, after a1 , 48h
|
||||||
|
|
||||||
|
section Last section
|
||||||
|
Describe gantt syntax :after doc1, 3d
|
||||||
|
Add gantt diagram to demo page :20h
|
||||||
|
Add another diagram to demo page :48h
|
||||||
|
```
|
||||||
|
|
||||||
|
```mermaid
|
||||||
gantt
|
gantt
|
||||||
dateFormat :YYYY-MM-DD
|
dateFormat :YYYY-MM-DD
|
||||||
title Adding GANTT diagram functionality to mermaid
|
title Adding GANTT diagram functionality to mermaid
|
||||||
@@ -428,12 +490,68 @@ mermaid
|
|||||||
|
|
||||||
SomethingElse --> [*]
|
SomethingElse --> [*]
|
||||||
|
|
||||||
|
```
|
||||||
|
```mermaid
|
||||||
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
||||||
|
stateDiagram
|
||||||
|
[*] --> Active
|
||||||
|
|
||||||
|
state Active {
|
||||||
|
[*] --> NumLockOff
|
||||||
|
NumLockOff --> NumLockOn : EvNumLockPressed
|
||||||
|
NumLockOn --> NumLockOff : EvNumLockPressed
|
||||||
|
--
|
||||||
|
[*] --> CapsLockOff
|
||||||
|
CapsLockOff --> CapsLockOn : EvCapsLockPressed
|
||||||
|
CapsLockOn --> CapsLockOff : EvCapsLockPressed
|
||||||
|
--
|
||||||
|
[*] --> ScrollLockOff
|
||||||
|
ScrollLockOff --> ScrollLockOn : EvCapsLockPressed
|
||||||
|
ScrollLockOn --> ScrollLockOff : EvCapsLockPressed
|
||||||
|
}
|
||||||
|
state SomethingElse {
|
||||||
|
A --> B
|
||||||
|
B --> A
|
||||||
|
}
|
||||||
|
|
||||||
|
Active --> SomethingElse
|
||||||
|
note right of SomethingElse : This is the note to the right.
|
||||||
|
|
||||||
|
SomethingElse --> [*]
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### State diagram (beta)
|
### State diagram (beta)
|
||||||
|
|
||||||
```
|
```
|
||||||
mermaid
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
||||||
|
stateDiagram-v2
|
||||||
|
[*] --> Active
|
||||||
|
|
||||||
|
state Active {
|
||||||
|
[*] --> NumLockOff
|
||||||
|
NumLockOff --> NumLockOn : EvNumLockPressed
|
||||||
|
NumLockOn --> NumLockOff : EvNumLockPressed
|
||||||
|
--
|
||||||
|
[*] --> CapsLockOff
|
||||||
|
CapsLockOff --> CapsLockOn : EvCapsLockPressed
|
||||||
|
CapsLockOn --> CapsLockOff : EvCapsLockPressed
|
||||||
|
--
|
||||||
|
[*] --> ScrollLockOff
|
||||||
|
ScrollLockOff --> ScrollLockOn : EvCapsLockPressed
|
||||||
|
ScrollLockOn --> ScrollLockOff : EvCapsLockPressed
|
||||||
|
}
|
||||||
|
state SomethingElse {
|
||||||
|
A --> B
|
||||||
|
B --> A
|
||||||
|
}
|
||||||
|
|
||||||
|
Active --> SomethingElse2
|
||||||
|
note right of SomethingElse2 : This is the note to the right.
|
||||||
|
|
||||||
|
SomethingElse2 --> [*]
|
||||||
|
```
|
||||||
|
```mermaid
|
||||||
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
||||||
stateDiagram-v2
|
stateDiagram-v2
|
||||||
[*] --> Active
|
[*] --> Active
|
||||||
@@ -465,7 +583,17 @@ stateDiagram-v2
|
|||||||
### Entity Relations diagram
|
### Entity Relations diagram
|
||||||
|
|
||||||
```
|
```
|
||||||
mermaid
|
erDiagram
|
||||||
|
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
||||||
|
CUSTOMER ||--o{ ORDER : places
|
||||||
|
CUSTOMER ||--o{ INVOICE : "liable for"
|
||||||
|
DELIVERY-ADDRESS ||--o{ ORDER : receives
|
||||||
|
INVOICE ||--|{ ORDER : covers
|
||||||
|
ORDER ||--|{ ORDER-ITEM : includes
|
||||||
|
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
|
||||||
|
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
|
||||||
|
```
|
||||||
|
```mermaid
|
||||||
erDiagram
|
erDiagram
|
||||||
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
||||||
CUSTOMER ||--o{ ORDER : places
|
CUSTOMER ||--o{ ORDER : places
|
||||||
@@ -479,7 +607,18 @@ mermaid
|
|||||||
|
|
||||||
### User journey diagram
|
### User journey diagram
|
||||||
```
|
```
|
||||||
mermaid
|
journey
|
||||||
|
title My working day
|
||||||
|
section Go to work
|
||||||
|
Make tea: 5: Me
|
||||||
|
Go upstairs: 3: Me
|
||||||
|
Do work: 1: Me, Cat
|
||||||
|
section Go home
|
||||||
|
Go downstairs: 5: Me
|
||||||
|
Sit down: 5: Me
|
||||||
|
```
|
||||||
|
|
||||||
|
```mermaid
|
||||||
journey
|
journey
|
||||||
title My working day
|
title My working day
|
||||||
section Go to work
|
section Go to work
|
||||||
|
Reference in New Issue
Block a user