272 | 275 | 构建信息 276 | |
277 |
280 |
|
288 |
33 | ```mermaid
34 | graph LR;
35 | A[Hard edge] -->|Link text| B(Round edge)
36 | B --> C{Decision}
37 | C -->|One| D[Result one]
38 | C -->|Two| E[Result two]
39 | ```
40 |
41 |
42 | renders as
43 |
44 | ```mermaid
45 | graph LR;
46 | A[Hard edge] -->|Link text| B(Round edge)
47 | B --> C{Decision}
48 | C -->|One| D[Result one]
49 | C -->|Two| E[Result two]
50 | ```
51 |
52 | ## Sequence example
53 |
54 | {{}}
55 | sequenceDiagram
56 | participant Alice
57 | participant Bob
58 | Alice->>John: Hello John, how are you?
59 | loop Healthcheck
60 | John->John: Fight against hypochondria
61 | end
62 | Note right of John: Rational thoughts 87 | ```mermaid 88 | sequenceDiagram 89 | participant Alice 90 | participant Bob 91 | Alice->>John: Hello John, how are you? 92 | loop Healthcheck 93 | John->John: Fight against hypochondria 94 | end 95 | Note right of John: Rational thoughts101 | 102 | renders as 103 | 104 | ```mermaid 105 | sequenceDiagram 106 | participant Alice 107 | participant Bob 108 | Alice->>John: Hello John, how are you? 109 | loop Healthcheck 110 | John->John: Fight against hypochondria 111 | end 112 | Note right of John: Rational thoughts
prevail... 96 | John-->Alice: Great! 97 | John->Bob: How about you? 98 | Bob-->John: Jolly good! 99 | ``` 100 |
162 | ```mermaid 163 | gantt 164 | dateFormat YYYY-MM-DD 165 | title Adding GANTT diagram functionality to mermaid 166 | section A section 167 | Completed task :done, des1, 2014-01-06,2014-01-08 168 | Active task :active, des2, 2014-01-09, 3d 169 | Future task : des3, after des2, 5d 170 | Future task2 : des4, after des3, 5d 171 | section Critical tasks 172 | Completed task in the critical line :crit, done, 2014-01-06,24h 173 | Implement parser and jison :crit, done, after des1, 2d 174 | Create tests for parser :crit, active, 3d 175 | Future task in critical line :crit, 5d 176 | Create tests for renderer :2d 177 | Add to mermaid :1d 178 | ``` 179 |180 | 181 | renders as 182 | 183 | ```mermaid 184 | gantt 185 | dateFormat YYYY-MM-DD 186 | title Adding GANTT diagram functionality to mermaid 187 | section A section 188 | Completed task :done, des1, 2014-01-06,2014-01-08 189 | Active task :active, des2, 2014-01-09, 3d 190 | Future task : des3, after des2, 5d 191 | Future task2 : des4, after des3, 5d 192 | section Critical tasks 193 | Completed task in the critical line :crit, done, 2014-01-06,24h 194 | Implement parser and jison :crit, done, after des1, 2d 195 | Create tests for parser :crit, active, 3d 196 | Future task in critical line :crit, 5d 197 | Create tests for renderer :2d 198 | Add to mermaid :1d 199 | ``` 200 | 201 | ### Class example 202 | 203 |
204 | ```mermaid 205 | classDiagram 206 | Class01 <|-- AveryLongClass : Cool 207 | Class03 *-- Class04 208 | Class05 o-- Class06 209 | Class07 .. Class08 210 | Class09 --> C2 : Where am i? 211 | Class09 --* C3 212 | Class09 --|> Class07 213 | Class07 : equals() 214 | Class07 : Object[] elementData 215 | Class01 : size() 216 | Class01 : int chimp 217 | Class01 : int gorilla 218 | Class08 <--> C2: Cool label 219 | ``` 220 |221 | 222 | renders as 223 | 224 | ```mermaid 225 | classDiagram 226 | Class01 <|-- AveryLongClass : Cool 227 | Class03 *-- Class04 228 | Class05 o-- Class06 229 | Class07 .. Class08 230 | Class09 --> C2 : Where am i? 231 | Class09 --* C3 232 | Class09 --|> Class07 233 | Class07 : equals() 234 | Class07 : Object[] elementData 235 | Class01 : size() 236 | Class01 : int chimp 237 | Class01 : int gorilla 238 | Class08 <--> C2: Cool label 239 | ``` 240 | 241 | ### Git example 242 | 243 |
244 | ```mermaid
245 | gitGraph:
246 | options
247 | {
248 | "nodeSpacing": 150,
249 | "nodeRadius": 10
250 | }
251 | end
252 | commit
253 | branch newbranch
254 | checkout newbranch
255 | commit
256 | commit
257 | checkout master
258 | commit
259 | commit
260 | merge newbranch
261 | ```
262 |
263 |
264 | renders as
265 |
266 | ```mermaid
267 | gitGraph:
268 | options
269 | {
270 | "nodeSpacing": 150,
271 | "nodeRadius": 10
272 | }
273 | end
274 | commit
275 | branch newbranch
276 | checkout newbranch
277 | commit
278 | commit
279 | checkout master
280 | commit
281 | commit
282 | merge newbranch
283 | ```
--------------------------------------------------------------------------------
/shortcodes/mermaid.fr.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : "Mermaid"
3 | description : "Génération de diagrammes à partir de texte, dans le même style que Markdown"
4 | ---
5 |
6 | [Mermaid](https://mermaidjs.github.io/) est une bibliothèque Javascript qui permet de générer des diagrammes (séquence, état, gantt, etc.) à partir de texte, dans le même style que Markdown.
7 |
8 | Insérer votre code Mermaid dans un shortcode `mermaid` et c'est tout.
9 |
10 | ## Flowchart example
11 | {{}}
12 | graph LR;
13 | A[Bords droits] -->|Lien texte| B(Bords arondis)
14 | B --> C{Décision}
15 | C -->|Un| D[Résultat un]
16 | C -->|Deux| E[Résultat deux]
17 | {{}}
18 |
19 | renders as
20 |
21 | {{
32 | ```mermaid
33 | graph LR;
34 | A[Bords droits] -->|Lien texte| B(Bords arondis)
35 | B --> C{Décision}
36 | C -->|Un| D[Résultat un]
37 | C -->|Deux| E[Résultat deux]
38 | ```
39 |
40 |
41 | renders as
42 |
43 | ```mermaid
44 | graph LR;
45 | A[Bords droits] -->|Lien texte| B(Bords arondis)
46 | B --> C{Décision}
47 | C -->|Un| D[Résultat un]
48 | C -->|Deux| E[Résultat deux]
49 | ```
50 |
51 | ## Sequence example
52 |
53 | {{}}
54 | sequenceDiagram
55 | participant Alice
56 | participant Bob
57 | Alice->>John: Salut John, comment vas-tu?
58 | loop Vérification
59 | John->John: Se bat contre l'hyponcodrie.
60 | end
61 | Note right of John: Les pensées rationnelles86 | ```mermaid 87 | sequenceDiagram 88 | participant Alice 89 | participant Bob 90 | Alice->>John: Salut John, comment vas-tu? 91 | loop Vérification 92 | John->John: Se bat contre l'hyponcodrie. 93 | end 94 | Note right of John: Les pensées rationnelles100 | 101 | renders as 102 | 103 | ```mermaid 104 | sequenceDiagram 105 | participant Alice 106 | participant Bob 107 | Alice->>John: Salut John, comment vas-tu? 108 | loop Vérification 109 | John->John: Se bat contre l'hyponcodrie. 110 | end 111 | Note right of John: Les pensées rationnelles
prédominent... 95 | John-->Alice: Super! 96 | John->Bob: Et toi? 97 | Bob-->John: Au top! 98 | ``` 99 |
162 | ```mermaid 163 | gantt 164 | dateFormat YYYY-MM-DD 165 | title Ajout de la fonctionnalité de GANTT à Mermaid 166 | section Une section 167 | Tâche complétée :done, des1, 2014-01-06,2014-01-08 168 | Tâche en cours :active, des2, 2014-01-09, 3d 169 | Future tâche : des3, after des2, 5d 170 | Future tâche 2 : des4, after des3, 5d 171 | section Tâches critiques 172 | Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h 173 | Implémenter le parser et jison :crit, done, after des1, 2d 174 | Créer des tests pour le parser :crit, active, 3d 175 | Future tâche dans le chemin critique :crit, 5d 176 | Créer des tests pour le renderer :2d 177 | Ajout à Mermaid :1d 178 | ``` 179 |180 | 181 | renders as 182 | 183 | ```mermaid 184 | gantt 185 | dateFormat YYYY-MM-DD 186 | title Ajout de la fonctionnalité de GANTT à Mermaid 187 | section Une section 188 | Tâche complétée :done, des1, 2014-01-06,2014-01-08 189 | Tâche en cours :active, des2, 2014-01-09, 3d 190 | Future tâche : des3, after des2, 5d 191 | Future tâche 2 : des4, after des3, 5d 192 | section Tâches critiques 193 | Tâche complétée dans le chemin critique :crit, done, 2014-01-06,24h 194 | Implémenter le parser et jison :crit, done, after des1, 2d 195 | Créer des tests pour le parser :crit, active, 3d 196 | Future tâche dans le chemin critique :crit, 5d 197 | Créer des tests pour le renderer :2d 198 | Ajout à Mermaid :1d 199 | ``` 200 | 201 | ### Class example 202 | 203 |
204 | ```mermaid 205 | classDiagram 206 | Class01 <|-- AveryLongClass : Cool 207 | Class03 *-- Class04 208 | Class05 o-- Class06 209 | Class07 .. Class08 210 | Class09 --> C2 : Where am i? 211 | Class09 --* C3 212 | Class09 --|> Class07 213 | Class07 : equals() 214 | Class07 : Object[] elementData 215 | Class01 : size() 216 | Class01 : int chimp 217 | Class01 : int gorilla 218 | Class08 <--> C2: Cool label 219 | ``` 220 |221 | 222 | renders as 223 | 224 | ```mermaid 225 | classDiagram 226 | Class01 <|-- AveryLongClass : Cool 227 | Class03 *-- Class04 228 | Class05 o-- Class06 229 | Class07 .. Class08 230 | Class09 --> C2 : Where am i? 231 | Class09 --* C3 232 | Class09 --|> Class07 233 | Class07 : equals() 234 | Class07 : Object[] elementData 235 | Class01 : size() 236 | Class01 : int chimp 237 | Class01 : int gorilla 238 | Class08 <--> C2: Cool label 239 | ``` 240 | 241 | ### Git example 242 | 243 |
244 | ```mermaid
245 | gitGraph:
246 | options
247 | {
248 | "nodeSpacing": 150,
249 | "nodeRadius": 10
250 | }
251 | end
252 | commit
253 | branch newbranch
254 | checkout newbranch
255 | commit
256 | commit
257 | checkout master
258 | commit
259 | commit
260 | merge newbranch
261 | ```
262 |
263 |
264 | renders as
265 |
266 | ```mermaid
267 | gitGraph:
268 | options
269 | {
270 | "nodeSpacing": 150,
271 | "nodeRadius": 10
272 | }
273 | end
274 | commit
275 | branch newbranch
276 | checkout newbranch
277 | commit
278 | commit
279 | checkout master
280 | commit
281 | commit
282 | merge newbranch
283 | ```
284 |
--------------------------------------------------------------------------------
/shortcodes/notice.en.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Notice
3 | description : "Disclaimers to help you structure your page"
4 | ---
5 |
6 | The notice shortcode shows 4 types of disclaimers to help you structure your page.
7 |
8 | ### Note
9 |
10 | ```
11 | {{%/* notice note */%}}
12 | A notice disclaimer
13 | {{%/* /notice */%}}
14 | ```
15 |
16 | renders as
17 |
18 | {{% notice note %}}
19 | A notice disclaimer
20 | {{% /notice %}}
21 |
22 | ### Info
23 |
24 | ```
25 | {{%/* notice info */%}}
26 | An information disclaimer
27 | {{%/* /notice */%}}
28 | ```
29 |
30 | renders as
31 |
32 | {{% notice info %}}
33 | An information disclaimer
34 | {{% /notice %}}
35 |
36 | ### Tip
37 |
38 | ```
39 | {{%/* notice tip */%}}
40 | A tip disclaimer
41 | {{%/* /notice */%}}
42 | ```
43 |
44 | renders as
45 |
46 | {{% notice tip %}}
47 | A tip disclaimer
48 | {{% /notice %}}
49 |
50 | ### Warning
51 |
52 | ```
53 | {{%/* notice warning */%}}
54 | A warning disclaimer
55 | {{%/* /notice */%}}
56 | ```
57 |
58 | renders as
59 |
60 | {{% notice warning %}}
61 | A warning disclaimer
62 | {{% /notice %}}
63 |
--------------------------------------------------------------------------------
/shortcodes/notice.fr.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Notice
3 | description : "Message pour vous aider à structurer votre contenu"
4 | ---
5 |
6 | Le shortcode *Notice* permet d'afficher 4 types de message pour vous aider à structurer votre contenu.
7 |
8 | ### Note
9 |
10 | ```
11 | {{%/* notice note */%}}
12 | Une notice de type *note*
13 | {{%/* /notice */%}}
14 | ```
15 |
16 | s'affiche comme
17 |
18 | {{% notice note %}}
19 | Une notice de type *note*
20 | {{% /notice %}}
21 |
22 | ### Info
23 |
24 | ```
25 | {{%/* notice info */%}}
26 | Une notice de type *info*
27 | {{%/* /notice */%}}
28 | ```
29 |
30 | s'affiche comme
31 |
32 | {{% notice info %}}
33 | Une notice de type *info*
34 | {{% /notice %}}
35 |
36 | ### Tip
37 |
38 | ```
39 | {{%/* notice tip */%}}
40 | Une notice de type *tip*
41 | {{%/* /notice */%}}
42 | ```
43 |
44 | s'affiche comme
45 |
46 | {{% notice tip %}}
47 | Une notice de type *tip*
48 | {{% /notice %}}
49 |
50 | ### Warning
51 |
52 | ```
53 | {{%/* notice warning */%}}
54 | Une notice de type *warning*
55 | {{%/* /notice */%}}
56 | ```
57 |
58 | s'affiche comme
59 |
60 | {{% notice warning %}}
61 | Une notice de type *warning*
62 | {{% /notice %}}
--------------------------------------------------------------------------------
/shortcodes/siteparam.en.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Site param
3 | description : "Get value of site params variables in your page."
4 | ---
5 |
6 | `siteparam` shortcode is used to help you print values of site params.
7 |
8 | For instance, in this current site, the `editURL` variable is used in `config.toml`
9 |
10 | ```toml
11 | [params]
12 | editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
13 | ```
14 |
15 | Use the `siteparam` shortcode to display its value.
16 |
17 | ```
18 | `editURL` Value : {{%/* siteparam "editURL" */%}}
19 | ```
20 |
21 | is displayed as
22 |
23 | `editURL` Value : {{% siteparam "editURL" %}}
--------------------------------------------------------------------------------
/shortcodes/siteparam.fr.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Site param
3 | description : "Afficher la valeur d'un paramètre global du site dans votre page"
4 | ---
5 |
6 | Les shortcode `siteparam` est utilisé pour vous aider à afficher des valeurs provenant des paramètres globaux du site.
7 |
8 | Par exemple, dans ce site, le paramètre `editURL` est utilisé dans le fichier `config.toml`
9 |
10 | ```toml
11 | [params]
12 | editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
13 | ```
14 |
15 | Utilisez le shortcode `siteparam` pour affichier sa valeur.
16 |
17 | ```
18 | Valeur de `editURL` : {{%/* siteparam "editURL" */%}}
19 | ```
20 |
21 | s'affiche comme
22 |
23 | Valeur de `editURL` : {{% siteparam "editURL" %}}
--------------------------------------------------------------------------------