Skip to main content

Alerts in GitHub-flavored Markdown

URL
https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

They’re also called admonitions or callouts elsewhere.

Markdown syntax

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Org syntax

#+begin_quote
[!NOTE]
Useful information that users should know, even when skimming content.
#+end_quote

#+begin_quote
[!TIP]
Helpful advice for doing things better or more easily.
#+end_quote

#+begin_quote
[!IMPORTANT]
Key information users need to know to achieve their goal.
#+end_quote

#+begin_quote
[!WARNING]
Urgent info that needs immediate user attention to avoid problems.
#+end_quote

#+begin_quote
[!CAUTION]
Advises about risks or negative outcomes of certain actions.
#+end_quote

Preview

(I guess this only works if you’re viewing this file from GitHub.)

[!NOTE] Useful information that users should know, even when skimming content.

[!TIP] Helpful advice for doing things better or more easily.

[!IMPORTANT] Key information users need to know to achieve their goal.

[!WARNING] Urgent info that needs immediate user attention to avoid problems.

[!CAUTION] Advises about risks or negative outcomes of certain actions.