Admonitions #

Admonitions (also known as callouts or alerts) are used to highlight important information in your documentation. Romero supports GitHub-style admonition syntax.

Syntax #

Admonitions use blockquote syntax with a special marker on the first line:

> [!NOTE]
> This is a note with helpful information.

> [!TIP]
> This is a tip with a helpful suggestion.

> [!IMPORTANT]
> This is important information the reader should know.

> [!WARNING]
> This is a warning about potential issues.

> [!CAUTION]
> This is a caution about dangerous actions.

Types #

There are five admonition types, each with its own color and icon:

Note

Use notes to provide additional context or clarification.

Tip

Use tips for helpful suggestions or best practices.

Important

Use important for critical information the reader must know.

Warning

Use warnings to alert readers about potential problems.

Caution

Use caution for dangerous operations that could cause data loss or security issues.

Multi-paragraph Content #

Admonitions can contain multiple paragraphs and other markdown elements:

> [!WARNING]
> This is the first paragraph.
>
> This is the second paragraph with **bold** and *italic* text.
>
> - List item 1
> - List item 2

Renders as:

Warning

This is the first paragraph.

This is the second paragraph with bold and italic text.

List item 1
List item 2