Using Alerts in GitHub Flavored Markdown (GFM) for Enhanced Documentation

I've recently discovered that GFM (also Obsidian and MkDocs) supports alerts which are a Markdown extension that you can use to emphasize important information.

> [!NOTE]
> Test note

GFM supports five types of alerts:

• NOTE
• TIP
• IMPORTANT
• WARNING
• CAUTION

Note

Useful information that users should know.

Tip

Helpful advice that helps user to do things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Information that needs user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.