You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| tip | renders a blue-green text box (icon slightly more green) |
46
+
| success | renders a green text box |
47
+
| question | renders a light green text box |
50
48
| warning | renders an orange text box |
49
+
| failure | renders a light red text box |
50
+
| danger | renders a red text box |
51
+
| bug | renders a red text box |
52
+
| example | renders a purple text box |
53
+
| quote | renders a grey text box |
51
54
| custom <sub>1</sub> | always renders a blue text box |
52
-
| custom <sub>2</sub> | uses a custom title within another type |
55
+
| custom <sub>2</sub> | uses a custom title within another type |
53
56
54
57
There is no limit on the types of admonitions you can use as noted in custom <sub>1</sub> above. A custom title can be added to any of the other admonition types to get the colored box you want for a specific admonition, as noted in custom <sub>2</sub> above.
55
58
@@ -65,39 +68,39 @@ The body text of the admonition must be indented four (4) spaces from the beginn
65
68
66
69
Here are examples of each admonition type, and how they will look in your document:
67
70
68
-
!!! attention
71
+
!!! note
69
72
70
73
text
71
74
72
-
!!! caution
75
+
!!! abstract
73
76
74
77
text
75
78
76
-
!!! danger
79
+
!!! info
77
80
78
81
text
79
82
80
-
!!! error
83
+
!!! tip
81
84
82
85
text
83
86
84
-
!!! hint
87
+
!!! success
85
88
86
89
text
87
90
88
-
!!! important
91
+
!!! question
89
92
90
93
text
91
94
92
-
!!! note
95
+
!!! warning
93
96
94
97
text
95
98
96
-
!!! tip
99
+
!!! failure
97
100
98
101
text
99
102
100
-
!!! warning
103
+
!!! danger
101
104
102
105
text
103
106
@@ -210,17 +213,21 @@ Tables help us to lay out command options, or in the above case, admonition type
| tip | renders a blue-green text box (icon slightly more green) |
220
+
| success | renders a green text box |
221
+
| question | renders a light green text box |
221
222
| warning | renders an orange text box |
223
+
| failure | renders a light red text box |
224
+
| danger | renders a red text box |
225
+
| bug | renders a red text box |
226
+
| example | renders a purple text box |
227
+
| quote | renders a grey text box |
222
228
| custom <sub>1</sub> | always renders a blue text box |
223
-
| custom <sub>2</sub> | uses a customer title within another type |
229
+
| custom <sub>2</sub> | uses a custom title within another type |
230
+
224
231
```
225
232
226
233
Note that it isn't necessary to have each column broken down by size (as we've done in the first part of the table), but it is certainly more readable in the markdown source file. It can get confusing when you string the items together, simply by breaking the columns with the pipe character "|" wherever the natural break would be, as you can see in the last two items of the table.
@@ -326,7 +333,7 @@ You can even embed a table or block quote (literally any formatting item type) w
326
333
327
334
2. If you are feeling overwhelmed, consider:
328
335
329
-
!!! important "important: I think my brain hurts!"
336
+
!!! warning "important: I think my brain hurts!"
330
337
331
338
When combining multiple formatting elements, your brain can go a little crazy. Consider sucking down some extra caffeine before you begin!
332
339
@@ -355,7 +362,7 @@ You can even embed a table or block quote (literally any formatting item type) w
355
362
356
363
2. If you are feeling overwhelmed, consider:
357
364
358
-
!!! important "important: I think my brain hurts!"
365
+
!!! warning "important: I think my brain hurts!"
359
366
360
367
When combining multiple formatting elements, your brain can go a little crazy. Consider sucking down some extra caffeine before you begin!
0 commit comments