Skip to content

Commit d6d8922

Browse files
authored
Updated contributing guidelines for alert boxes (#7489)
1 parent f77a1ae commit d6d8922

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,17 @@ Links between docs can be achieved by using a hash symbol (#), plus the markdown
3838

3939
### Alert Boxes
4040

41-
Alert boxes are created using a block quote that has one of 'warn', 'danger', 'info', or 'preview' on the first line.
42-
For example:
41+
Alert boxes are created by placing a line with 3 colons (`:::`) before and after the text. The first 3 colons must be followed by a label specifying the alert box type. For example, to create a warning alert:
4342

4443
```
4544
:::warn
4645
Something that requires warning here
4746
:::
4847
```
4948

50-
![Alert options](static/images/alerts.png)
49+
Currently the following types are available: `info`, `warn`, `danger` and `preview`
50+
51+
![Available alert types](static/images/alerts.png)
5152

5253
### MDX Components
5354

0 commit comments

Comments
 (0)