mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-01-14 06:43:25 +08:00
294 lines
8.1 KiB
Markdown
294 lines
8.1 KiB
Markdown
# Theming
|
|
|
|
Mermaid as a system for theming in place. With it a site integrator can override a vast majority of attributes used when rendering a diagram.
|
|
|
|
The settings for a theme can be set globally for the site with the initialize call. The example below highlights how that can look:
|
|
|
|
```
|
|
// example
|
|
```
|
|
|
|
It is also possible to override theme settings locally in a diagram using directives.
|
|
|
|
```
|
|
%%{init: {'theme':'base'}}%%
|
|
graph TD
|
|
a --> b
|
|
```
|
|
|
|
The easiest way to make a custom theme is to start with the base theme, the theme named base and just modify these variables:
|
|
* primaryColor - the base color for the theme
|
|
|
|
More specific color variables it is possible to change:
|
|
* lineColor
|
|
* textColor
|
|
|
|
Here is an example of a showcase flowchart with theme set to base, with the default variables set:
|
|
```mermaid
|
|
%%{init: {'theme':'base'}}%%
|
|
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
|
|
```
|
|
|
|
Here is an example of overriding the primary color and giving everything a little different look.
|
|
```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
|
|
```
|
|
As the theming engine is using color codes to calculate values from the base color/base colors it needs proper color values contrain the actual color data. Aliases like color names is not supported so for instance, the color value 'red' will not work but '#ff0000' will work.
|
|
|
|
## Showcases
|
|
|
|
When adjusting a theme it might be helpful to look at the theme with these diagrams to evaluate that everything is visiable and looks good.
|
|
|
|
### flowchart
|
|
```
|
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
|
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
|
|
```
|
|
```mermaid
|
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
|
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
|
|
```
|
|
|
|
### flowchart (beta)
|
|
```mermaid
|
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
|
flowchart TD
|
|
A[Christmas] -->|Get money| B(Go shopping)
|
|
B --> C{Let me think}
|
|
B --> G[Another]
|
|
C ==>|One| D[Laptop]
|
|
C x--x|Two| E[iPhone]
|
|
C o--o|Three| F[fa:fa-car Car]
|
|
subgraph section
|
|
C
|
|
D
|
|
E
|
|
F
|
|
G
|
|
end
|
|
```
|
|
|
|
### Sequence diagram
|
|
|
|
```mermaid
|
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
|
|
|
sequenceDiagram
|
|
autonumber
|
|
par Action 1
|
|
Alice->>John: Hello John, how are you?
|
|
and Action 2
|
|
Alice->>Bob: Hello Bob, how are you?
|
|
end
|
|
Alice->>+John: Hello John, how are you?
|
|
Alice->>+John: John, can you hear me?
|
|
John-->>-Alice: Hi Alice, I can hear you!
|
|
Note right of John: John is perceptive
|
|
John-->>-Alice: I feel great!
|
|
loop Every minute
|
|
John-->Alice: Great!
|
|
end
|
|
```
|
|
|
|
### class diagram
|
|
|
|
```mermaid
|
|
%%{init: {'securityLevel': 'loose', 'theme':'base'}}%%
|
|
|
|
classDiagram
|
|
Animal "1" <|-- Duck
|
|
Animal <|-- Fish
|
|
Animal <--o Zebra
|
|
Animal : +int age
|
|
Animal : +String gender
|
|
Animal: +isMammal()
|
|
Animal: +mate()
|
|
class Duck{
|
|
+String beakColor
|
|
+swim()
|
|
+quack()
|
|
}
|
|
class Fish{
|
|
-int sizeInFeet
|
|
-canEat()
|
|
}
|
|
class Zebra{
|
|
+bool is_wild
|
|
+run()
|
|
}
|
|
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
### State diagram
|
|
```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)
|
|
|
|
```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 --> [*]
|
|
```
|
|
|
|
### 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"
|
|
```
|
|
|
|
### User journet 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
|
|
``` |