diff --git a/README.md b/README.md index 6e43248dc7..e8ffba65cb 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,19 @@ C -->|Two| E[Result 2] ``` -##Sequence [docs - live editor] +## Sequence diagram [docs - live editor] +``` +sequenceDiagram +Alice->>John: Hello John, how are you? +loop Healthcheck + John->>John: Fight against hypochondria +end +Note right of John: Rational thoughts! +John-->>Alice: Great! +John->>Bob: How about you? +Bob-->>John: Jolly good! +``` ```mermaid sequenceDiagram Alice->>John: Hello John, how are you? @@ -69,8 +80,18 @@ John->>Bob: How about you? Bob-->>John: Jolly good! ``` -## Gantt [docs - live editor] +## Gantt chart [docs - live editor] +``` +gantt + section Section + Completed :done, des1, 2014-01-06,2014-01-08 + Active :active, des2, 2014-01-07, 3d + Parallel 1 : des3, after des1, 1d + Parallel 2 : des4, after des1, 1d + Parallel 3 : des5, after des3, 1d + Parallel 4 : des6, after des4, 1d +``` ```mermaid gantt section Section @@ -82,12 +103,30 @@ gantt Parallel 4 : des6, after des4, 1d ``` -## Class [docs - live editor] +## Class diagram [docs - live editor] +``` +classDiagram +Class01 <|-- AveryLongClass : Cool +<> Class01 +Class09 --> C2 : Where am i? +Class09 --* C3 +Class09 --|> Class07 +Class07 : equals() +Class07 : Object[] elementData +Class01 : size() +Class01 : int chimp +Class01 : int gorilla +class Class10 { + <> + int id + size() +} +``` ```mermaid classDiagram -Class01 <|-- AveryLongClass : Cool -<<interface>> Class01 +Class01 <|-- AveryLongClass : Cool +<> Class01 Class09 --> C2 : Where am i? Class09 --* C3 Class09 --|> Class07 @@ -97,13 +136,22 @@ Class01 : size() Class01 : int chimp Class01 : int gorilla class Class10 { - <<service>> + <> int id size() } ``` -##State [docs - live editor] +## State diagram [docs - live editor] +``` +stateDiagram-v2 +[*] --> Still +Still --> [*] +Still --> Moving +Moving --> Still +Moving --> Crash +Crash --> [*] +``` ```mermaid stateDiagram-v2 [*] --> Still @@ -114,9 +162,14 @@ Moving --> Crash Crash --> [*] ``` -### Pie
- [docs - live editor] +### Pie chart [docs - live editor] +``` +pie +"Dogs" : 386 +"Cats" : 85 +"Rats" : 15 +``` ```mermaid pie "Dogs" : 386 @@ -124,9 +177,20 @@ pie "Rats" : 15 ``` -## Git [experimental - live editor] +## Git graph [experimental - live editor] -## User Journey [docs - live editor] +## User Journey diagram [docs - live editor] +``` + 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: 3: Me +``` ```mermaid journey title My working day