From 0f4486f8c77a4a860b03e59739a439d2081dff5f Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Tue, 22 Apr 2025 20:16:13 +0200 Subject: [PATCH] Updated contributing guidelines for alert boxes --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efb02c8245..726348caad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,8 +38,7 @@ Links between docs can be achieved by using a hash symbol (#), plus the markdown ### Alert Boxes -Alert boxes are created using a block quote that has one of 'warn', 'danger', 'info', or 'preview' on the first line. -For example: +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: ``` :::warn @@ -47,7 +46,9 @@ Something that requires warning here ::: ``` -![Alert options](static/images/alerts.png) +Currently the following types are available: `info`, `warn`, `danger` and `preview` + +![Available alert types](static/images/alerts.png) ### MDX Components