Admonitions

Admonitions, also known as call-outs, are an excellent choice for including side content without significantly interrupting the document flow:

Syntax

Admonitions are created using the following syntax:

::: type | Some optional title
Some content
:::

type will be used as the CSS class name and as the default title. It must be a single word. For instance:

::: note
Some content.

More content.
:::

will render as:

Optionally, you can use custom titles. For example:

::: error | Don't try this at home
This is an admonition box
:::

will render as:

Supported types

WriteADoc includes these default types: note, tip, warning, error, and new.

Collapsible admonitions (details)

If you add an open option, the admonition is rendered as a details/summary block with a small toggle on the right side:

::: note | Some summary
:open: false

Some content
:::

will render as:

If you wish to specify a details block as open (not collapsed), simply use the :open: true option.

::: note | Some summary
:open: true

Some content
:::

will render as:

Inline admonitions

If the screen is wide enough, you can have inline admonitions, by wrapping the content in a :::: div columns block (use four or more ":"):

::::: div columns

::: tip | Lorem Ipsum
Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Nulla et euismod nulla.
:::

Some other content
:::::