Skip to main content

Type of Admonition

  1. Note
  2. Tip
  3. Info
  4. Warning
  5. Danger

Note admonitions​

:::note

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

:::
note

Some content with Markdown syntax. Check this api.

Tip admonitions​

:::tip

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

:::
tip

Some content with Markdown syntax. Check this api.

Info admonitions​

:::info

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

:::
info

Some content with Markdown syntax. Check this api.

Warning admonitions​

:::warning

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

:::
warning

Some content with Markdown syntax. Check this api.

Danger admonitions​

:::danger

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

:::
danger

Some content with Markdown syntax. Check this api.

Formatting Lists inside Admonitions​

In Docusaurus (and Markdown in general), a single line break is treated as a space. This means if you list items on separate lines without bullet points, they will collapse into a single paragraph.

❌ The Issue: Missing Bullets​

If you do not use bullet points, your list will look broken.

Code:

:::info
Target Audience: Developers
Difficulty: Beginner
Prerequisites: Node.js
:::

Visual Result (Collapsed Text):

info

Target Audience: Developers Difficulty: Beginner Prerequisites: Node.js

✅ The Fix: Use Bullet Points​

To display items on separate lines, simply add a * or - before each item.

Code:

:::info
* **Target Audience**: Developers
* **Difficulty**: Beginner
* **Prerequisites**: Node.js
:::

Visual Result (Clean List):

info
  • Target Audience: Developers
  • Difficulty: Beginner
  • Prerequisites: Node.js