Badges

Badges

Introduction

A light-weight plugin for displaying inline "badges" in [Obsidian.md](https://github.com/obsidianmd).

Installation

[Install from community.obsidian.md](https://community.obsidian.md/plugins/badges)

From Obsidian's settings or preferences:

1. Community Plugins > Browse
2. Search for "Badges"

Manually:

1. download the latest release archive
2. uncompress the downloaded archive
3. move the badges folder to /path/to/vault/.obsidian/plugins/
4. Settings > Community plugins > reload Installed plugins
5. enable plugin

or:

1. download main.js, manifest.json & styles.css from the latest release
2. create a new folder /path/to/vault/.obsidian/plugins/badges
3. move all 3 files to /path/to/vault/.obsidian/plugins/badges
4. Settings > Community plugins > reload Installed plugins
5. enable plugin

Usage

default syntax

`[!!KEY:VAL]`

syntax	details
KEY	the type and name of the ICON
VAL	the value and text displayed

shorthand syntax

For built-in badge types, you can omit the value and colon:

`[!!KEY]`

For example, `[!!success]` displays as "Success" with a checkmark icon. This works for all types defined in [constants.ts](https://github.com/gapmiss/badges/blob/master/src/constants.ts).

[!TIP] In addition to the built-in badge types (note, info, success, etc.), you can use any [Lucide icon](https://lucide.dev/icons/) name as the `KEY`. For example: `[!!rocket:launched]` or `[!!heart:favorite]`.

[!IMPORTANT] the `VAL` cannot contain either the `|` pipe or the `:` colon symbols, as they are used as delimiters for the custom syntax. See [Usage in tables](#usage-in-tables) for using badges inside Markdown tables.

example

`[!!note:note]