Playing With Admonitions

I’ve added the possibility of generating Asciidoctor-style admonitions to this website, not only in the final HTML generated for this website, but also in the PDF and EPUB outputs, and you might have seen them in action in previous posts.

In Asciidoctor and Antora I liked to use such highlighted blocks, to showcase some particular information, so I wanted to have them on this website too. Although, as you might imagine, Markdown does not provide this capability per se.

The Markdown code I use looks like this, showing its corresponding output below.

Notes

Great for extra information.

::: note
This is a note.
:::
This is a note.

Tips

In green, for suggestions or shortcuts.

::: tip
This is a tip.
:::
This is a tip.

Important

Emphasis you must not miss.

::: important
This is important.
:::
This is important.

Caution

Risk of confusion or bad outcome.

::: caution
This is a cautionary tale.
:::
This is a cautionary tale.

Warning

To highlight hazard or serious consequences.

::: warning
This is a warning.
:::
This is a warning.

PDF and EPUB

This also works in the PDF and EPUB outputs, too.