Skip to content

Instantly share code, notes, and snippets.

@rochacbruno

rochacbruno/admonition.md

Last active October 21, 2024 15:45
Show Gist options
  • Save rochacbruno/35e654ddc0052f0d88ea63c6b87bc6ae to your computer and use it in GitHub Desktop.
Save rochacbruno/35e654ddc0052f0d88ea63c6b87bc6ae to your computer and use it in GitHub Desktop.
Download ZIP
Github markdown admonition
Raw
admonition.md

Note

Highlights information that users should take into account, even when skimming.

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.

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

> [!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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment