Skip to content

Instantly share code, notes, and snippets.

@Merwanski

Merwanski/notes_warnings.md

Created June 13, 2024 07:43
Show Gist options
  • Save Merwanski/1be1f2ba250d4b0bc960a3237d653f54 to your computer and use it in GitHub Desktop.
Save Merwanski/1be1f2ba250d4b0bc960a3237d653f54 to your computer and use it in GitHub Desktop.
Download ZIP
An option to highlight a "Note" and "Warning" using blockquote
Raw
notes_warnings.md

What to use?

> [!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.

Results

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.

Ref

Thanks to https://github.com/orgs/community/discussions/16925

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment