Admonition Options
Placing a code block with the admonition type:
```ad-note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
Becomes:
Options
Permalink```ad-<type> # Admonition type — see types.md for the full list.
title: # Admonition title (optional).
collapse: # open | closed | none
icon: # Override the icon.
color: # Override the color.
metadata: # Arbitrary value set as data-callout-metadata attribute.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
As of 4.4.1, the title, collapse, icon, color and metadata parameters must be at the top of the block, in any order.
Title
PermalinkThe admonition will render with the type of admonition by default. If you wish to customize the title, you can do so this way:
```ad-note
title: Title
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
Custom titles are rendered as Markdown, so they support the full Markdown syntax available to Obsidian.
```ad-note
title: $\sum\frac{\pi}{\sigma}$
```
Becomes:
Leave the title field blank to only display the admonition content without a title.
```ad-note
title:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
Collapsible
PermalinkTo create a collapsible admonition, add the collapse parameter. Valid values:
| Value | Behavior |
|---|---|
open |
Renders open; can be collapsed by clicking the title |
closed |
Renders collapsed; can be expanded by clicking the title |
none |
Forces the admonition to be non-collapsible, even if "Collapsible By Default" is enabled in settings |
If the admonition's title is left blank, the collapse parameter has no effect.
You can set all admonitions to be collapsible by default in the settings.
Mermaid diagrams render correctly inside admonitions regardless of collapse state.
Icon
PermalinkTo override the icon for a single codeblock, use the icon parameter. The name must exactly match an icon from an enabled icon pack (Font Awesome Solid/Regular/Brands, Octicons, or RPG Awesome — configure which packs are downloaded and active under Settings → Icon Packs).
```ad-note
icon: triforce
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
Image icons (PNG, etc.) configured in the admonition settings only work in codeblock mode, not in callout syntax (> [!type]). If you need consistent icon styling across both, use the Style with CSS option and define --callout-icon in a CSS snippet.
Color
PermalinkTo override the color for a single codeblock, use the color parameter with an RGB triad — three integers (0–255) separated by commas.
For example: color: 255, 0, 0 sets the color to red, and color: 0, 128, 0 sets the color to green.
```ad-note
color: 200, 200, 200
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
The color parameter has no effect when Set Admonition Colors is disabled in plugin settings, or when the admonition type has Style with CSS enabled. In those cases, color is controlled entirely by CSS.
Metadata
PermalinkThe metadata parameter sets a data-callout-metadata attribute on the rendered admonition element. It has no default visual effect, but makes the value available for CSS and JavaScript to target specific admonitions.
```ad-note
metadata: my-value
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
```
For callout syntax, metadata is specified after a | pipe inside the brackets:
> [!note|my-value] Title
> Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Both forms set data-callout-metadata="my-value" on the element, which can be used in CSS snippets:
.callout[data-callout-metadata="my-value"] {
/* custom styles */
}
No Content
PermalinkIf an admonition is created without any content, only the title block will be rendered.
```ad-note
```