Skip to content

Note and Warning markdown for GitHub

Note

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

Tip

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

Important

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

Warning

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

Caution

> [!CAUTION]
> Negative potential consequences of an action.

These won't render in mkdocs

For that, see Admonitions

Extra Reading


Want to make this site better? Open a PR or help fund hosting costs