Post

GitHub README.md

GitHub README.md

GitHub Alerts

GitHub introduced this syntax to create visually distinct callout blocks. There are 5 types:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
> [!NOTE]
> Highlights information that users should take into account.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.
This post is licensed under CC BY 4.0 by the author.