Admonitions

GitHub Repo | Changelog | Issues

The Admonitions plugin for Obsidian adds block-styled content and callout functionality to your notes, with a design inspired by Material for MkDocs.

1. Create either a code block or a callout using Admonitions.
2. Set default titles, default collapse states, or default no-title options for the callouts you create with Admonitions.
3. Admonitions includes editor suggestions to speed up the process of creating custom admonitions and callout boxes.
4. Admonitions provides helpful commands for inserting callout boxes and the ability to register commands for specific types.
5. Download optional icon packs: Font Awesome (Solid, Regular, Brands), Octicons, and RPG Awesome. As of v12.0.4, Font Awesome packs are also downloaded (a migration step will download them automatically if you had Font Awesome icons in use).
6. Check out the Obsidian TTRPG-Share's Repository of Admonitions for some starter admonitions.

Admonitions supports two syntaxes. Both use the same type names, and any custom type you define in settings works as either form.

Callout (Obsidian's native syntax — simpler, works everywhere):

> [!tip] This is a tip
> This is the content of the admonition.

Code block (plugin syntax — supports additional parameters):

```ad-tip
title: This is a tip
collapse: open

This is the content of the admonition.
```

Code blocks support title:, collapse:, icon:, and color: parameters. See Admonition Options for details.

1. Admonition Options
   • Types of Admonitions
   • Nesting Admonitions
2. Settings
3. Command Palette
4. Create an Admonition
5. Import an Admonition

1. Admonition CSS
2. JSON Specification
3. API
4. Localizing Admonitions
5. Publish.js with Admonitions

▶ Video walkthrough on YouTube