Essentials
Admonitions
Author notes, tips, warnings, and danger messages with Markdown directives.
Use admonitions when a short block of content needs to stand out from normal prose without switching to component syntax.
Lotus supports Markdown directives for note, tip, warning, caution, and
danger. The directives render through the same callout system used by the
Callout component.
Basic Syntax
Use three colons, the admonition type, an optional title in brackets, then close the block with another three colons.
:::tip[Use the starter template]Start with the starter when you want the fastest path to a working docs site.:::Use the starter template
Start with the starter when you want the fastest path to a working docs site.
Types
Choose the type that matches the intent of the message.
Note
Use notes for neutral context, implementation details, and caveats.
Tip
Use tips for recommended workflows, shortcuts, and smoother paths through a task.
Warning
Use warnings when a choice can cause confusing behavior, broken output, or extra setup work.
Danger
Use danger messages for destructive actions, security-sensitive steps, and irreversible changes.
Starlight Compatibility
Lotus also accepts caution for Starlight compatibility. It renders as a
warning-style admonition.
:::caution[Check before deploying]Review environment variables before publishing the site.:::Check before deploying
Review environment variables before publishing the site.
When To Use Components
Use directives for normal documentation prose. Use the
Callout component when a page already uses MDX
components or when you need component props directly.
Last updated Jul 20, 2026
