Admonitions API

The Admonitions plugin exposes a programmatic API that other plugins can use to register, remove, and inspect admonition types at runtime.

There is no separate API object — methods are accessed directly on the plugin instance:

const plugin = this.app.plugins.plugins["obsidian-admonition"];

Registers a new custom admonition type. Updates CSS and saves settings.

await plugin.addAdmonition({
    type: "my-type",
    title: "My Type",
    icon: { type: "font-awesome", name: "star" },
    color: "200, 50, 50",
    command: false,
    iconWithCss: false,
    noTitle: false,
    copy: false,
});

Removes a custom admonition type. Cleans up CSS and saves settings.

// Look up the admonition object first, then remove it
const admonition = plugin.admonitions["my-type"];
if (admonition) {
    await plugin.removeAdmonition(admonition);
}

Returns all available admonition types — both built-in and user-defined — keyed by type name.

const all = plugin.admonitions;
// { note: {...}, tip: {...}, "my-type": {...}, ... }

Returns all admonitions as an array with the type property included on each object.

for (const admonition of plugin.admonitionArray) {
    console.log(admonition.type, admonition.icon);
}

Returns an array of all registered admonition type names.

console.log(plugin.types);
// ["note", "tip", "warning", "my-type", ...]

Icon operations are delegated to plugin.iconManager.

Downloads an optional icon pack.

await plugin.downloadIcon("rpg");

Removes a downloaded icon pack.

await plugin.removeIcon("rpg");

See JSON Specification for the full Admonition interface with field descriptions.

interface Admonition {
    type: string;
    title?: string;
    icon: AdmonitionIconDefinition;
    color: string;
    command: boolean;
    iconWithCss?: boolean;
    /** @deprecated Use iconWithCss instead. */
    injectColor?: boolean;
    noTitle: boolean;
    copy?: boolean;
}

type AdmonitionIconDefinition = {
    type?: IconType;
    name?: string;  // Exact icon name from the chosen icon pack
};

type IconType =
    | "obsidian"
    | "image"
    | DownloadableIconPack;

// Downloadable packs (can be enabled in Settings → Icon Packs)
type DownloadableIconPack =
    | "fas"       // Font Awesome Solid
    | "far"       // Font Awesome Regular
    | "fab"       // Font Awesome Brands
    | "octicons"  // GitHub Octicons
    | "rpg";      // RPG Awesome