Admonition Blocks: Making Your Documentation Stand Out

Last updated on Sep 15, 2022 1 min read

Documentation doesn’t always have to be boring. Admonition blocks draw the reader’s attention to important notes and warnings that may not directly fit as part of the flow of the text.

As I often prefer to write long-form reports and documentation in LaTeX, awesomebox and alertmessage are my go-to packages for admonition blocks. Several simple examples may be found below.

% !TEX program = xelatex
\documentclass{article}

% dummy text for examples
\usepackage{lipsum}

% admonition blocks around text to inform/alert readers
\usepackage{awesomebox}
% or without using xelatex
\usepackage{alertmessage}

\begin{document}

% awesomebox
\tipbox{\lipsum[2]}
\notebox{\lipsum[3]}
\warningbox{\lipsum[4]}
\cautionbox{\lipsum[5]}
\importantbox{\lipsum[5]}

% alertmessage
\alertinfo{\lipsum[2]}
\alertsuccess{\lipsum[2]}
\alertwarning{\lipsum[2]}
\alerterror{\lipsum[2]}

\end{document}

Admonition Blocks: Making Your Documentation Stand Out

Nicholas Nadeau, Ph.D., P.Eng.

Founder / Fractional CTO

Related