Admonitions

Grammar

This feature integrated remark-directive

Icon pre-build required

The iconify icons should be in the Pre-build iconify icons config

:::tip|info|note|warning|important|caution|danger[Title]{icon=icon-collection:icon-name}
Some admonition content
:::
md

Tip

Tip title

Some tip content

Tip with custom icon

Some tip content

:::tip[Tip title]
Some tip content
:::

:::tip[Tip with custom icon]{icon=ph:smiley}
Some tip content
:::
md
View code

Info

Info title

Some info content

Info with custom icon

Some info content

:::info[Info title]
Some info content
:::

:::info[Info with custom icon]{icon=ph:smiley}
Some info content
:::
md
View code

Note

Note title

Some note content

Note with custom icon

Some note content

:::note[Note title]
Some note content
:::

:::note[Note with custom icon]{icon=ph:smiley}
Some note content
:::
md
View code

Warning

Warning title

Some warning content

Warning with custom icon

Some warning content

:::warning[Warning title]
Some warning content
:::

:::warning[Warning with custom icon]{icon=ph:smiley}
Some warning content
:::
md
View code

Important

Important title

Some important content

Important with custom icon

Some important content

:::important[Important title]
Some important content
:::

:::important[Important with custom icon]{icon=ph:smiley}
Some important content
:::
md
View code

Caution

Caution title

Some caution content

Caution with custom icon

Some caution content

:::caution[Caution title]
Some caution content
:::

:::caution[Caution with custom icon]{icon=ph:smiley}
Some caution content
:::
md
View code

Danger

Danger title

Some danger content

Danger with custom icon

Some danger content

:::danger[Danger title]
Some danger content
:::

:::danger[Danger with custom icon]{icon=ph:smiley}
Some danger content
:::
md
View code

Links and inline code

Links and inline code inside an admonition inherit the admonition's theme color and background:

Tip title

A tip link and tip both match the tip color.

Info title

An info link and info both match the info color.

Note title

A note link and note both match the note color.

Warning title

A warning link and warning both match the warning color.

Important title

An important link and important both match the important color.

Caution title

A caution link and caution both match the caution color.

Danger title

A danger link and danger both match the danger color.

:::tip[Tip title]
A [tip link](/guide/introduction/) and `tip` both match the tip color.
:::

:::info[Info title]
An [info link](/guide/introduction/) and `info` both match the info color.
:::

:::note[Note title]
A [note link](/guide/introduction/) and `note` both match the note color.
:::

:::warning[Warning title]
A [warning link](/guide/introduction/) and `warning` both match the warning color.
:::

:::important[Important title]
An [important link](/guide/introduction/) and `important` both match the important color.
:::

:::caution[Caution title]
A [caution link](/guide/introduction/) and `caution` both match the caution color.
:::

:::danger[Danger title]
A [danger link](/guide/introduction/) and `danger` both match the danger color.
:::
md
View code
Last update at: 2026/08/29 02:04