Admonitions

Admonitions are callout boxes that highlight important information.

Usage

Note Title

This is a note admonition.

Tip Title

This is a tip admonition.

Warning Title

This is a warning admonition.

Danger Title

This is a danger admonition.

Types

• note: Informational notes
• tip: Helpful suggestions
• warning: Warnings and cautions
• danger: Critical warnings

Examples

Note

This is a standard note for general information.

Best Practice

Always use clear, descriptive titles for your admonitions.

Breaking Change

This API will change in the next release.

Security Risk

Never commit secrets or credentials to the repository.