Callouts isolate information that requires the reader’s immediate attention. docmd provides five semantic types, each with distinct styling and iconography.
If migrating from VitePress or Docusaurus, you can use their native syntax:
:::tip,:::warning,:::danger,:::info(VitePress):::note,:::caution(Docusaurus)
These aliases render identically to their docmd equivalents. Spaceless syntax like :::callout also works.
Syntax Reference
::: callout type "Title text" [property:value...]
The content or warning goes here.
:::
| Parameter | Type | Description |
|---|---|---|
| Type | info | tip | warning | danger | success |
The semantic intent which defines default colours and iconography. |
| Title | "String" |
Optional. Overrides the default semantic label with a custom title. |
| Icon | icon:NAME |
Optional. Overrides the default icon with a custom Lucide icon. |
Supported Types
| Type | Visual Signal |
|---|---|
info |
Contextual background or helpful non-critical information. |
tip |
Performance shortcuts or best practices. |
warning |
Potential issues or deprecated features to monitor. |
danger |
Risk of data loss, breaking changes, or critical failures. |
success |
Confirmation of a successful configuration or build. |
Examples
Basic Callout
A minimal callout without a title uses the type as its default label.
::: callout info
Legacy configuration schemas remain supported but are no longer recommended.
:::
Legacy configuration schemas remain supported but are no longer recommended.
Custom Title & Icon
Override the default label and icon with a custom title and any Lucide icon name.
::: callout warning "Breaking Change" icon:alert-triangle
The internal WebSocket RPC system is officially deprecated.
:::
The internal WebSocket RPC system is officially deprecated.
Rich Content Composition
Callouts support full Markdown. Embed code blocks and buttons directly within the alert.
::: callout tip "Optimised Local Testing" icon:command
Use the preserve flag to maintain build files during dev sessions:
```bash
npx @docmd/core dev --preserve
```
::: button "CLI Flag Reference" /cli-commands
:::
Use the preserve flag to maintain build files during dev sessions:
npx @docmd/core dev --preserve
For LLMs, callouts act as High-Priority Anchors. Use ::: callout danger to document breaking changes — this provides a clear signal that the AI model must prioritise that information.
