Login Register

vita / Markdown-alerts

Last active 2 weeks ago

Like 0
markdown

vita revised this gist 2 weeks ago · 4763337

1 file changed, 39 insertions

markdown-alerts.md (file created)
@@ -0,0 +1,39 @@
1 + Alerts are an extension of Markdown used to emphasize critical information. On GitHub, they are displayed with distinctive colors and icons to indicate the importance of the content.
2 +
3 + **An example of all five types:**
4 +
5 + ```markdown
6 + > [!NOTE]
7 + > Highlights information that users should take into account, even when skimming.
8 +
9 + > [!TIP]
10 + > Optional information to help a user be more successful.
11 +
12 + > [!IMPORTANT]
13 + > Crucial information necessary for users to succeed.
14 +
15 + > [!WARNING]
16 + > Critical content demanding immediate user attention due to potential risks.
17 +
18 + > [!CAUTION]
19 + > Negative potential consequences of an action.
20 + ```
21 +
22 + **Here is how they are displayed:**
23 +
24 + > [!NOTE]
25 + > Highlights information that users should take into account, even when skimming.
26 +
27 + > [!TIP]
28 + > Optional information to help a user be more successful.
29 +
30 + > [!IMPORTANT]
31 + > Crucial information necessary for users to succeed.
32 +
33 + > [!WARNING]
34 + > Critical content demanding immediate user attention due to potential risks.
35 +
36 + > [!CAUTION]
37 + > Negative potential consequences of an action.
38 +
39 + Sauce: https://github.com/orgs/community/discussions/16925