DEV Community

Cover image for GitHub Flavored Callouts

Posted on • Originally published at

GitHub Flavored Callouts

I enjoyed adding support for callouts in zaui today.

Here's an example:

Screenshot with standard callout

And here's the markdown source,

> [!TIP]
> The [zaui guide]( has more details.
Enter fullscreen mode Exit fullscreen mode

The markdown format matches the recently introduced GitHub Markdown Alerts extension.

In addition to the now GitHub standard [!NOTE|TIP|IMPORTANT|CAUTION|WARNING] you can also follow the [!{something}] pattern, to make up your own callouts, perhaps with an emoji.

> [!πŸ’₯ zaui]
> Getting a little better every day
Enter fullscreen mode Exit fullscreen mode

Screenshot with custom zaui callout

Careful, this πŸ‘† only works with zaui, not on GitHub.


Along with this change, zaui also gained a next button in the Post layout.

This should make it easier to navigate to the next page in the guide, and to the next post in the blog.

You can try it out at the top of this page...

Screenshot with a "Next" button


Top comments (0)