Skip to content

Instantly share code, notes, and snippets.

@danpetitt

danpetitt/markdown-tips.md

Last active September 14, 2024 20:09
Show Gist options
  • Save danpetitt/1550e6d67083614753e35d9fa3f27849 to your computer and use it in GitHub Desktop.
Save danpetitt/1550e6d67083614753e35d9fa3f27849 to your computer and use it in GitHub Desktop.
Download ZIP
GitHub Markdown Updates
Raw
markdown-tips.md

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

Optional information to help a user be more successful.

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

Important

Crucial information necessary for users to succeed.

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

Warning

Critical content demanding immediate user attention due to potential risks.

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

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