Copy page

Writing

Admonitions

In addition to the basic Markdown syntax, we have a special admonitions syntax by wrapping text with a set of 3 colons, followed by a label denoting its type.

Example:

Code
:::note

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::tip

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::info

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::warning

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::danger

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

Additional types

Beyond the standard severity types, the following themed variants are available with their own color and icon:

Code
:::sparkles

For new features or AI-powered functionality.

:::

:::rocket

For getting-started or launch-related content.

:::

:::settings

For configuration sections.

:::

:::zap

For performance tips.

:::

:::lock

For authentication and security notes.

:::

:::megaphone

For announcements.

:::

With title

You can also add a title to the admonition by adding it after the type:

Code
:::warning{title="Warning of the day"}

The path of the righteous man is beset on all sides by the iniquities of the selfish and the tyranny
of evil men.

:::

Usage with Prettier

If you use Prettier to format your Markdown files, Prettier might auto-format your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content.

Code
<!-- Prettier doesn't change this -->

:::note

Hello world

:::

<!-- Prettier changes this -->

:::note 
Hello world 
:::

<!-- to this -->

::: note Hello world:::