Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Admonitions (:::warning, etc.)

We support a series of admonition directives:

  • :::warning
  • :::important
  • :::tip
  • :::note
  • :::info

Each directive can optionally specify a custom title in square brackets.

Example:

Markdown
:::warning

This is a warning.

:::

:::important

This is an important notice.

:::

:::note

This is a note.

:::

:::tip

This is a tip.

:::

:::info[Preview]

This is an info notice with a custom title (suggested for features in Preview).

:::

Output:

warning

This is a warning.

important

This is an important notice.

tip

This is a tip.

note

This is a note.

Preview

This is an info notice with a custom title (suggested for features in Preview).