GFM Alerts
July 1, 2026 ยท View on GitHub
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Important
Key information users need to know to achieve their goal.
Warning
Urgent info that needs immediate user attention to avoid problems.
Caution
Advises about risks or negative outcomes of certain actions.
Alerts with multiple lines
Note
This is a longer note that spans multiple lines. It continues here with more context. And wraps onto a third line as well.
Alerts with inline formatting
Warning
Do not run this command as root. It will permanently delete all data in the target directory and cannot be undone.
Alerts mixed with regular block quotes
A regular block quote for comparison:
This is just a regular block quote. It should not be treated as an alert.
Important
Back to an alert after a regular block quote.