Admonitions

Admonitions draw attention to important information. Each type is styled distinctively.

Note

This is a note admonition. Use notes for additional information that supplements the main content.

Tip

This is a tip admonition. Tips provide helpful suggestions or best practices.

Important

This is an important admonition. Use this for critical information the reader must not miss.

Warning

This is a warning admonition. Warnings alert readers to potential problems or risks.

Caution

This is a caution admonition. Cautions indicate actions that could have negative consequences.

Admonitions with Titles

Configuration Required

You must configure the antora-playbook.yml file before building the site. See the installation guide for details.
Performance Optimization

Enable caching in your playbook for faster subsequent builds:

runtime:
  cache_dir: .cache/antora
Breaking Changes in v2.0

The configuration format changed in version 2.0. Please review the migration guide before upgrading.

Admonitions with Complex Content

Multi-step Process

Follow these steps in order:

  1. Clone the repository

  2. Install dependencies with pnpm install

  3. Configure your playbook

  4. Run pnpm build

git clone https://github.com/example/my-project.git
cd my-project
pnpm install
pnpm build
Data Loss Warning

The following actions are irreversible:

  • Deleting a branch without a backup

  • Force pushing to a shared branch

  • Running git clean -fd without reviewing changes

Always create backups before performing destructive operations.

Action Risk Level

git reset --hard

High

git push --force

Critical

git clean -fd

High

Inline Admonitions

You can also use shorter inline syntax:

Short notes can be written inline.
Quick tips are great for brevity.
Brief warnings catch attention.