Skip to main content

Admonitions

Overview

Docusaurus supports 5 types of admonitions:

  • info
  • note
  • tip
  • warning
  • danger

Admonitions are useful for highlighting important information, warnings, or tips within a page. They can be used to draw attention to specific information or to provide additional context to a page.

Usage

Admonitions are defined using the following syntax:

:::note
This is a note
:::

Each type of admonition can be seen below:

info

This is an info admonition

note

This is a note admonition

tip

This is a tip admonition

warning

This is a warning admonition

danger

This is a danger admonition