A concise rewrite of the mermaid documentation for quick lookups.
Meta:
- Overview (comments, configuring, etc)
Example | Code |
flowchart LR
A[Start] --> B{Should you?}
B -- Yes --> C{{Do it}}
B -- Maybe --> D[(Save for later)]
B -- No --> E[Okay]
|
|
sequenceDiagram
Alice ->>+ Bob: Here's a message!
Bob ->>- Alice: Hmm, ok, thanks.
|
|
classDiagram
class ClassName {
String stringName
Long longName
MyDatatype attributeName
functionName(parameter) ReturnType
functionName2(parameter2) ReturnType
}
class Interface {
Int intName
}
ClassName --|> Interface
|
|
4: State | |
5: Entity Relationship | |
6: User Journey | |
7: Gantt | |
8: Pie | |
9: Requirement | |
10: Others |