Upgrade mermaid-js/mermaid @ 0918b97 (v8.8.0) (#443)

* Upgrade mermaid-js/mermaid @ 0918b97

* Update exampleSite with new mermaid graph (stateDiagram-v2) example

* Update content of mermaid.js with officially distributed v8.8.0 minified version
This commit is contained in:
Susan Potter 2020-09-10 11:12:32 -05:00 committed by GitHub
parent 48a0e36c8a
commit 699c9fdf9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 329 additions and 342 deletions

View file

@ -9,41 +9,39 @@ Just insert your mermaid code in the `mermaid` shortcode and that's it.
## Flowchart example ## Flowchart example
{{</*mermaid align="left"*/>}} {{</*mermaid align="left"*/>}}
graph LR; graph LR;
A[Hard edge] -->|Link text| B(Round edge) A[Hard edge] -->|Link text| B(Round edge)
B --> C{Decision} B --> C{Decision}
C -->|One| D[Result one] C -->|One| D[Result one]
C -->|Two| E[Result two] C -->|Two| E[Result two]
{{</* /mermaid */>}} {{</* /mermaid */>}}
renders as renders as
{{<mermaid align="left">}} {{<mermaid align="left">}}
graph LR; graph LR;
A[Hard edge] -->|Link text| B(Round edge) A[Hard edge] -->|Link text| B(Round edge)
B --> C{Decision} B --> C{Decision}
C -->|One| D[Result one] C -->|One| D[Result one]
C -->|Two| E[Result two] C -->|Two| E[Result two]
{{< /mermaid >}} {{</mermaid>}}
or you can use this alternative syntax: or you can use this alternative syntax:
<pre> ```mermaid
```mermaid graph LR;
graph LR; A[Hard edge] -->|Link text| B(Round edge)
A[Hard edge] -->|Link text| B(Round edge) B --> C{Decision}
B --> C{Decision} C -->|One| D[Result one]
C -->|One| D[Result one] C -->|Two| E[Result two]
C -->|Two| E[Result two] ```
```
</pre>
renders as renders as
```mermaid ```mermaid
graph LR; graph LR;
A[Hard edge] -->|Link text| B(Round edge) A[Hard edge] -->|Link text| B(Round edge)
B --> C{Decision} B --> C{Decision}
C -->|One| D[Result one] C -->|One| D[Result one]
C -->|Two| E[Result two] C -->|Two| E[Result two]
@ -51,19 +49,19 @@ graph LR;
## Sequence example ## Sequence example
{{</*mermaid*/>}} {{</*mermaid*/>}}
sequenceDiagram sequenceDiagram
participant Alice participant Alice
participant Bob participant Bob
Alice->>John: Hello John, how are you? Alice->>John: Hello John, how are you?
loop Healthcheck loop Healthcheck
John->John: Fight against hypochondria John->John: Fight against hypochondria
end end
Note right of John: Rational thoughts <br/>prevail... Note right of John: Rational thoughts <br/>prevail...
John-->Alice: Great! John-->Alice: Great!
John->Bob: How about you? John->Bob: How about you?
Bob-->John: Jolly good! Bob-->John: Jolly good!
{{</* /mermaid */>}} {{</* /mermaid */>}}
renders as renders as
@ -79,61 +77,27 @@ sequenceDiagram
John-->Alice: Great! John-->Alice: Great!
John->Bob: How about you? John->Bob: How about you?
Bob-->John: Jolly good! Bob-->John: Jolly good!
{{< /mermaid >}} {{</mermaid>}}
or you can use this alternative syntax:
<pre>
```mermaid
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
```
</pre>
renders as
```mermaid
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
```
## GANTT Example ## GANTT Example
{{</*mermaid*/>}} {{</* 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
section A section section A section
Completed task :done, des1, 2014-01-06,2014-01-08 Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d Future task2 : des4, after des3, 5d
section Critical tasks section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d Future task in critical line :crit, 5d
Create tests for renderer :2d Create tests for renderer :2d
Add to mermaid :1d Add to mermaid :1d
{{</* /mermaid */>}} {{</* /mermaid */>}}
renders as renders as
@ -156,72 +120,30 @@ gantt
Add to mermaid :1d Add to mermaid :1d
{{</mermaid>}} {{</mermaid>}}
or you can use this alternative syntax:
<pre>
```mermaid
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
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
```
</pre>
renders as
```mermaid
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
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
```
### Class example ### Class example
<pre> {{</* mermaid */>}}
```mermaid classDiagram
classDiagram Class01 <|-- AveryLongClass : Cool
Class01 <|-- AveryLongClass : Cool Class03 *-- Class04
Class03 *-- Class04 Class05 o-- Class06
Class05 o-- Class06 Class07 .. Class08
Class07 .. Class08 Class09 --> C2 : Where am i?
Class09 --> C2 : Where am i? Class09 --* C3
Class09 --* C3 Class09 --|> Class07
Class09 --|> Class07 Class07 : equals()
Class07 : equals() Class07 : Object[] elementData
Class07 : Object[] elementData Class01 : size()
Class01 : size() Class01 : int chimp
Class01 : int chimp Class01 : int gorilla
Class01 : int gorilla Class08 <--> C2: Cool label
Class08 <--> C2: Cool label {{</* /mermaid */>}}
```
</pre>
renders as renders as
```mermaid
{{<mermaid>}}
classDiagram classDiagram
Class01 <|-- AveryLongClass : Cool Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04 Class03 *-- Class04
@ -236,30 +158,29 @@ classDiagram
Class01 : int chimp Class01 : int chimp
Class01 : int gorilla Class01 : int gorilla
Class08 <--> C2: Cool label Class08 <--> C2: Cool label
``` {{</mermaid>}}
### Git example ### Git example
<pre> ```mermaid
```mermaid gitGraph:
gitGraph: options
options {
{ "nodeSpacing": 150,
"nodeSpacing": 150, "nodeRadius": 10
"nodeRadius": 10 }
} end
end commit
commit branch newbranch
branch newbranch checkout newbranch
checkout newbranch commit
commit commit
commit checkout master
checkout master commit
commit commit
commit merge newbranch
merge newbranch ```
```
</pre>
renders as renders as
@ -280,4 +201,30 @@ end
commit commit
commit commit
merge newbranch merge newbranch
``` ```
### State Diagrams
{{</* mermaid */>}}
stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --> closed: Close
closed --> locked: Lock
locked --> closed: Unlock
closed --> open: Open
{{</* /mermaid */>}}
renders as
{{<mermaid>}}
stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --> closed: Close
closed --> locked: Lock
locked --> closed: Unlock
closed --> open: Open
{{</mermaid>}}

View file

@ -8,216 +8,208 @@ description : "Génération de diagrammes à partir de texte, dans le même styl
Insérer votre code Mermaid dans un shortcode `mermaid` et c'est tout. Insérer votre code Mermaid dans un shortcode `mermaid` et c'est tout.
## Flowchart example ## Flowchart example
{{</*mermaid align="left"*/>}} {{</*mermaid align="left"*/>}}
graph LR; graph LR;
A[Bords droits] -->|Lien texte| B(Bords arondis) A[Bords droits] -->|Lien texte| B(Bords arondis)
B --> C{Décision} B --> C{Décision}
C -->|Un| D[Résultat un] C -->|Un| D[Résultat un]
C -->|Deux| E[Résultat deux] C -->|Deux| E[Résultat deux]
{{</* /mermaid */>}} {{</* /mermaid */>}}
renders as renders as
{{<mermaid align="left">}} {{<mermaid align="left">}}
graph LR; graph LR;
A[Bords droits] -->|Lien texte| B(Bords arondis) A[Bords droits] -->|Lien texte| B(Bords arondis)
B --> C{Décision} B --> C{Décision}
C -->|Un| D[Résultat un] C -->|Un| D[Résultat un]
C -->|Deux| E[Résultat deux] C -->|Deux| E[Résultat deux]
{{< /mermaid >}} {{< /mermaid >}}
or you can use this alternative syntax: or you can use this alternative syntax:
<pre> ```mermaid
```mermaid graph LR;
graph LR; A[Bords droits] -->|Lien texte| B(Bords arondis)
A[Bords droits] -->|Lien texte| B(Bords arondis) B --> C{Décision}
B --> C{Décision} C -->|Un| D[Résultat un]
C -->|Un| D[Résultat un] C -->|Deux| E[Résultat deux]
C -->|Deux| E[Résultat deux] ```
```
</pre>
renders as renders as
```mermaid ```mermaid
graph LR; graph LR;
A[Bords droits] -->|Lien texte| B(Bords arondis) A[Bords droits] -->|Lien texte| B(Bords arondis)
B --> C{Décision} B --> C{Décision}
C -->|Un| D[Résultat un] C -->|Un| D[Résultat un]
C -->|Deux| E[Résultat deux] C -->|Deux| E[Résultat deux]
``` ```
## Sequence example ## Sequence example
{{</*mermaid*/>}} {{</*mermaid*/>}}
sequenceDiagram sequenceDiagram
participant Alice participant Alice
participant Bob participant Bob
Alice->>John: Salut John, comment vas-tu? Alice->>John: Salut John, comment vas-tu?
loop Vérification loop Vérification
John->John: Se bat contre l'hyponcodrie. John->John: Se bat contre l'hyponcodrie.
end end
Note right of John: Les pensées rationnelles<br/>prédominent... Note right of John: Les pensées rationnelles<br/>prédominent...
John-->Alice: Super! John-->Alice: Super!
John->Bob: Et toi? John->Bob: Et toi?
Bob-->John: Au top! Bob-->John: Au top!
{{</* /mermaid */>}} {{</* /mermaid */>}}
renders as renders as
{{<mermaid>}} {{<mermaid>}}
sequenceDiagram sequenceDiagram
participant Alice participant Alice
participant Bob participant Bob
Alice->>John: Salut John, comment vas-tu? Alice->>John: Salut John, comment vas-tu?
loop Vérification loop Vérification
John->John: Se bat contre l'hyponcodrie. John->John: Se bat contre l'hyponcodrie.
end end
Note right of John: Les pensées rationnelles<br/>prédominent... Note right of John: Les pensées rationnelles<br/>prédominent...
John-->Alice: Super! John-->Alice: Super!
John->Bob: Et toi? John->Bob: Et toi?
Bob-->John: Au top! Bob-->John: Au top!
{{< /mermaid >}} {{< /mermaid >}}
or you can use this alternative syntax: or you can use this alternative syntax:
<pre> ```mermaid
```mermaid sequenceDiagram
sequenceDiagram participant Alice
participant Alice participant Bob
participant Bob Alice->>John: Salut John, comment vas-tu?
Alice->>John: Salut John, comment vas-tu? loop Vérification
loop Vérification John->John: Se bat contre l'hyponcodrie.
John->John: Se bat contre l'hyponcodrie. end
end Note right of John: Les pensées rationnelles<br/>prédominent...
Note right of John: Les pensées rationnelles<br/>prédominent... John-->Alice: Super!
John-->Alice: Super! John->Bob: Et toi?
John->Bob: Et toi? Bob-->John: Au top!
Bob-->John: Au top! ```
```
</pre>
renders as renders as
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
participant Alice participant Alice
participant Bob participant Bob
Alice->>John: Salut John, comment vas-tu? Alice->>John: Salut John, comment vas-tu?
loop Vérification loop Vérification
John->John: Se bat contre l'hyponcodrie. John->John: Se bat contre l'hyponcodrie.
end end
Note right of John: Les pensées rationnelles<br/>prédominent... Note right of John: Les pensées rationnelles<br/>prédominent...
John-->Alice: Super! John-->Alice: Super!
John->Bob: Et toi? John->Bob: Et toi?
Bob-->John: Au top! Bob-->John: Au top!
``` ```
## GANTT Example ## GANTT Example
{{</*mermaid*/>}} {{</*mermaid*/>}}
gantt gantt
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
title Ajout de la fonctionnalité de GANTT à Mermaid title Ajout de la fonctionnalité de GANTT à Mermaid
section Une section section Une section
Tâche complétée :done, des1, 2014-01-06,2014-01-08 Tâche complétée :done, des1, 2014-01-06,2014-01-08
Tâche en cours :active, des2, 2014-01-09, 3d Tâche en cours :active, des2, 2014-01-09, 3d
Future tâche : des3, after des2, 5d Future tâche : des3, after des2, 5d
Future tâche 2 : des4, after des3, 5d Future tâche 2 : des4, after des3, 5d
section Tâches critiques section Tâches critiques
Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h
Implémenter le parser et jison :crit, done, after des1, 2d Implémenter le parser et jison :crit, done, after des1, 2d
Créer des tests pour le parser :crit, active, 3d Créer des tests pour le parser :crit, active, 3d
Future tâche dans le chemin critique :crit, 5d Future tâche dans le chemin critique :crit, 5d
Créer des tests pour le renderer :2d Créer des tests pour le renderer :2d
Ajout à Mermaid :1d Ajout à Mermaid :1d
{{</* /mermaid */>}} {{</* /mermaid */>}}
renders as renders as
{{<mermaid>}} {{<mermaid>}}
gantt gantt
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
title Ajout de la fonctionnalité de GANTT à Mermaid title Ajout de la fonctionnalité de GANTT à Mermaid
section Une section section Une section
Tâche complétée :done, des1, 2014-01-06,2014-01-08 Tâche complétée :done, des1, 2014-01-06,2014-01-08
Tâche en cours :active, des2, 2014-01-09, 3d Tâche en cours :active, des2, 2014-01-09, 3d
Future tâche : des3, after des2, 5d Future tâche : des3, after des2, 5d
Future tâche 2 : des4, after des3, 5d Future tâche 2 : des4, after des3, 5d
section Tâches critiques section Tâches critiques
Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h
Implémenter le parser et jison :crit, done, after des1, 2d Implémenter le parser et jison :crit, done, after des1, 2d
Créer des tests pour le parser :crit, active, 3d Créer des tests pour le parser :crit, active, 3d
Future tâche dans le chemin critique :crit, 5d Future tâche dans le chemin critique :crit, 5d
Créer des tests pour le renderer :2d Créer des tests pour le renderer :2d
Ajout à Mermaid :1d Ajout à Mermaid :1d
{{</mermaid>}} {{</mermaid>}}
or you can use this alternative syntax: or you can use this alternative syntax:
<pre> ```mermaid
```mermaid gantt
gantt dateFormat YYYY-MM-DD
dateFormat YYYY-MM-DD title Ajout de la fonctionnalité de GANTT à Mermaid
title Ajout de la fonctionnalité de GANTT à Mermaid section Une section
section Une section Tâche complétée :done, des1, 2014-01-06,2014-01-08
Tâche complétée :done, des1, 2014-01-06,2014-01-08 Tâche en cours :active, des2, 2014-01-09, 3d
Tâche en cours :active, des2, 2014-01-09, 3d Future tâche : des3, after des2, 5d
Future tâche : des3, after des2, 5d Future tâche 2 : des4, after des3, 5d
Future tâche 2 : des4, after des3, 5d section Tâches critiques
section Tâches critiques Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h
Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h Implémenter le parser et jison :crit, done, after des1, 2d
Implémenter le parser et jison :crit, done, after des1, 2d Créer des tests pour le parser :crit, active, 3d
Créer des tests pour le parser :crit, active, 3d Future tâche dans le chemin critique :crit, 5d
Future tâche dans le chemin critique :crit, 5d Créer des tests pour le renderer :2d
Créer des tests pour le renderer :2d Ajout à Mermaid :1d
Ajout à Mermaid :1d ```
```
</pre>
renders as renders as
```mermaid ```mermaid
gantt gantt
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
title Ajout de la fonctionnalité de GANTT à Mermaid title Ajout de la fonctionnalité de GANTT à Mermaid
section Une section section Une section
Tâche complétée :done, des1, 2014-01-06,2014-01-08 Tâche complétée :done, des1, 2014-01-06,2014-01-08
Tâche en cours :active, des2, 2014-01-09, 3d Tâche en cours :active, des2, 2014-01-09, 3d
Future tâche : des3, after des2, 5d Future tâche : des3, after des2, 5d
Future tâche 2 : des4, after des3, 5d Future tâche 2 : des4, after des3, 5d
section Tâches critiques section Tâches critiques
Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h
Implémenter le parser et jison :crit, done, after des1, 2d Implémenter le parser et jison :crit, done, after des1, 2d
Créer des tests pour le parser :crit, active, 3d Créer des tests pour le parser :crit, active, 3d
Future tâche dans le chemin critique :crit, 5d Future tâche dans le chemin critique :crit, 5d
Créer des tests pour le renderer :2d Créer des tests pour le renderer :2d
Ajout à Mermaid :1d Ajout à Mermaid :1d
``` ```
### Class example ### Class example
<pre> ```mermaid
```mermaid classDiagram
classDiagram Class01 <|-- AveryLongClass : Cool
Class01 <|-- AveryLongClass : Cool Class03 *-- Class04
Class03 *-- Class04 Class05 o-- Class06
Class05 o-- Class06 Class07 .. Class08
Class07 .. Class08 Class09 --> C2 : Where am i?
Class09 --> C2 : Where am i? Class09 --* C3
Class09 --* C3 Class09 --|> Class07
Class09 --|> Class07 Class07 : equals()
Class07 : equals() Class07 : Object[] elementData
Class07 : Object[] elementData Class01 : size()
Class01 : size() Class01 : int chimp
Class01 : int chimp Class01 : int gorilla
Class01 : int gorilla Class08 <--> C2: Cool label
Class08 <--> C2: Cool label ```
```
</pre>
renders as renders as
@ -240,26 +232,24 @@ classDiagram
### Git example ### Git example
<pre> ```mermaid
```mermaid gitGraph:
gitGraph: options
options {
{ "nodeSpacing": 150,
"nodeSpacing": 150, "nodeRadius": 10
"nodeRadius": 10 }
} end
end commit
commit branch newbranch
branch newbranch checkout newbranch
checkout newbranch commit
commit commit
commit checkout master
checkout master commit
commit commit
commit merge newbranch
merge newbranch ```
```
</pre>
renders as renders as
@ -281,3 +271,29 @@ end
commit commit
merge newbranch merge newbranch
``` ```
### State Diagrams
{{</* mermaid */>}}
stateDiagram-v2
ouvert: Ouvert
clos: Clos
fermé: Fermé
ouvert --> clos
clos --> fermé: Lock
fermé --> clos: Unlock
clos --> ouvert: Open
{{</* /mermaid */>}}
renders as
{{<mermaid>}}
stateDiagram-v2
ouvert: Ouvert
clos: Clos
fermé: Fermé
ouvert --> clos
clos --> fermé: Lock
fermé --> clos: Unlock
clos --> ouvert: Open
{{</mermaid>}}

File diff suppressed because one or more lines are too long