DEV Community

Cover image for How to use GitHub admonitions to make your markdown more readable
Michael Andreuzza
Michael Andreuzza

Posted on

How to use GitHub admonitions to make your markdown more readable

GitHub has support for admonitions - clean, styled callout boxes like [!NOTE], [!TIP], and [!WARNING] - in issues, PRs, discussions, and wikis.

If you've seen these floating around and wondered how they work (or why they aren't showing up in your README), this quick guide breaks it all down, with examples, copy-paste snippets, and tips for using them like a pro.

Read the full article here: 

Top comments (0)