Skip to content

Instantly share code, notes, and snippets.

@baysideengineer
Last active June 8, 2024 14:50
Show Gist options
  • Save baysideengineer/10080ef86033c5d9f3e97f3824909b4b to your computer and use it in GitHub Desktop.
Save baysideengineer/10080ef86033c5d9f3e97f3824909b4b to your computer and use it in GitHub Desktop.
Markdown highlight options for GitHub.

Note

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

Note

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

Tip

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

Tip

Optional information to help a user be more successful.

Important

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

Important

Crucial information necessary for users to succeed.

Warning

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

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

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

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