diff --git a/README.md b/README.md index 2c24ad1e0..6e43248dc 100644 --- a/README.md +++ b/README.md @@ -55,15 +55,9 @@ C -->|Two| E[Result 2] ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Sequence
- [docs - live editor] -
+##Sequence [docs - live editor]
+
+```mermaid
 sequenceDiagram
 Alice->>John: Hello John, how are you?
 loop Healthcheck
@@ -73,40 +67,24 @@ Note right of John: Rational thoughts!
 John-->>Alice: Great!
 John->>Bob: How about you?
 Bob-->>John: Jolly good!
-
- -
- Gantt
- [docs - live editor] -
+```
+
+## Gantt [docs - live editor]
+
+```mermaid
 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
-
- -
- Class
- [docs - live editor] -
+    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
+```
+
+## Class [docs - live editor]
+
+```mermaid
 classDiagram
 Class01 <|-- AveryLongClass : Cool
 <<interface>> Class01
@@ -123,19 +101,10 @@ class Class10 {
   int id
   size()
 }
-
 - -
- State
- [docs - live editor] -
+```
+
+##State [docs - live editor]
+```mermaid
 stateDiagram-v2
 [*] --> Still
 Still --> [*]
@@ -143,46 +112,22 @@ Still --> Moving
 Moving --> Still
 Moving --> Crash
 Crash --> [*]
-
 - -
- Pie
+``` + +### Pie
[docs - live editor] -
+
+```mermaid
 pie
 "Dogs" : 386
 "Cats" : 85
 "Rats" : 15
-
 - -
- Git
- [experimental - live editor] -
Coming soon!
- User Journey
- [docs - live editor] -
- 
+```
+
+## Git [experimental - live editor]
+
+## User Journey [docs - live editor]
+```mermaid
   journey
     title My working day
     section Go to work
@@ -192,14 +137,7 @@ pie
     section Go home
       Go downstairs: 5: Me
       Sit down: 3: Me
-
 - User Journey Diagram -
+``` ## Related projects @@ -226,16 +164,4 @@ A quick note from Knut Sveidqvist: --- -*Mermaid was created by Knut Sveidqvist for easier documentation.* - -|test|apa| -|----|---| -|flow| -```mermaid -flowchart TD -A[Hard] -->|Text| B(Round) -B --> C{Decision} -C -->|One| D[Result 1] -C -->|Two| E[Result 2] -``` -|sxt \ No newline at end of file +*Mermaid was created by Knut Sveidqvist for easier documentation.* \ No newline at end of file