Skip to content

Commit 6df96ec

Browse files
authored
# Changes to admonitions (#1085)
* changes to the types of admonitions changed * this required a rewrite of the admonitions section
1 parent 08fa7f9 commit 6df96ec

File tree

1 file changed

+34
-27
lines changed

1 file changed

+34
-27
lines changed

docs/guides/contribute/rockydocs_formatting.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,20 @@ Admonitions are special visual "boxes" that allow you to call attention to impor
3939

4040
| type | Description |
4141
|-----------|-----------------------------------------------------------|
42-
| attention | renders a light orange text box |
43-
| caution | renders a light orange text box |
44-
| danger | renders a red text box |
45-
| error | renders a red text box |
46-
| hint | renders a green text box |
47-
| important | renders a green text box |
4842
| note | renders a blue text box |
49-
| tip | renders a green text box |
43+
| abstract | renders a light blue text box |
44+
| info | renders a blue-green text box |
45+
| 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 |
5048
| 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 |
5154
| 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 |
5356

5457
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.
5558

@@ -65,39 +68,39 @@ The body text of the admonition must be indented four (4) spaces from the beginn
6568

6669
Here are examples of each admonition type, and how they will look in your document:
6770

68-
!!! attention
71+
!!! note
6972

7073
text
7174

72-
!!! caution
75+
!!! abstract
7376

7477
text
7578

76-
!!! danger
79+
!!! info
7780

7881
text
7982

80-
!!! error
83+
!!! tip
8184

8285
text
8386

84-
!!! hint
87+
!!! success
8588

8689
text
8790

88-
!!! important
91+
!!! question
8992

9093
text
9194

92-
!!! note
95+
!!! warning
9396

9497
text
9598

96-
!!! tip
99+
!!! failure
97100

98101
text
99102

100-
!!! warning
103+
!!! danger
101104

102105
text
103106

@@ -210,17 +213,21 @@ Tables help us to lay out command options, or in the above case, admonition type
210213
```
211214
| type | Description |
212215
|-----------|-----------------------------------------------------------|
213-
| attention | renders a light orange text box |
214-
| caution | renders a light orange text box |
215-
| danger | renders a red text box |
216-
| error | renders a red text box |
217-
| hint | renders a green text box |
218-
| important | renders a green text box |
219216
| note | renders a blue text box |
220-
| tip | renders a green text box |
217+
| abstract | renders a light blue text box |
218+
| info | renders a blue-green text box |
219+
| 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 |
221222
| 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 |
222228
| 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+
224231
```
225232

226233
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
326333

327334
2. If you are feeling overwhelmed, consider:
328335

329-
!!! important "important: I think my brain hurts!"
336+
!!! warning "important: I think my brain hurts!"
330337

331338
When combining multiple formatting elements, your brain can go a little crazy. Consider sucking down some extra caffeine before you begin!
332339

@@ -355,7 +362,7 @@ You can even embed a table or block quote (literally any formatting item type) w
355362
356363
2. If you are feeling overwhelmed, consider:
357364
358-
!!! important "important: I think my brain hurts!"
365+
!!! warning "important: I think my brain hurts!"
359366
360367
When combining multiple formatting elements, your brain can go a little crazy. Consider sucking down some extra caffeine before you begin!
361368

0 commit comments

Comments
 (0)