Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gapmiss/badges
A light-weight plugin for displaying inline "badges" in Obsidian.md
https://github.com/gapmiss/badges
badges badges-markdown obsidian obsidian-md obsidian-plugin
Last synced: about 2 months ago
JSON representation
A light-weight plugin for displaying inline "badges" in Obsidian.md
- Host: GitHub
- URL: https://github.com/gapmiss/badges
- Owner: gapmiss
- License: mit
- Created: 2023-07-10T13:00:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-06T13:57:20.000Z (about 1 year ago)
- Last Synced: 2024-10-30T08:50:55.708Z (about 2 months ago)
- Topics: badges, badges-markdown, obsidian, obsidian-md, obsidian-plugin
- Language: CSS
- Homepage:
- Size: 337 KB
- Stars: 63
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Badges
### Introduction
A light-weight plugin for displaying inline "badges" in [Obsidian.md](https://github.com/obsidianmd) which acts similarly to a key-value store(database) for querying via default search or [Dataview](https://github.com/blacksmithgu/obsidian-dataview) plugin.
- [Usage](#usage)
- [Github styled badges](#Github)
- [Plain-text](#Plain-text)
- [custom](#custom)
- [Installation](#Installation)
- [CSS styles](#CSS)
- [Dataview plugin](#Dataview)
- [Development](#Development)
- [Notes](#Notes)
### Usage
###### default syntax
```markdown
`[!!KEY:VAL]`
```
| syntax | details |
| ------ | ------------------------------- |
| `KEY` | the type and name of the `ICON` |
| `VAL` | the value and text displayed |
> [!IMPORTANT]
> the `VAL` cannot contain either the `|` pipe or the `:` colon symbols, as they are used as delimiters for the custom syntax
###### example
```markdown
`[!!note:note]`
`[!!info:info]`
`[!!todo:todo]`
...
`[!!cite:cite]`
```
###### results
###### example
```markdown
`[!!emergency: emergency]`
`[!!prohibit: prohibit]`
`[!!stop:stop]`
…
`[!!reward: reward]`
`[!!vault: vault]`
```
###### results
#### Github
###### syntax
```markdown
`[!!|GHX>KEY:VAL]`
```
| syntax | details |
| --------------- | ----------------------------------------------------------------------------------- |
| \| | start pipe symbol |
| `GHX` | Github style, either `ghb` for the blue style or `ghs` for the green success style |
| `>` | greater than symbol (delimiter) |
| `KEY:VAL` | `KEY` is the type or label, `VAL` is the value text displayed. e.g. `release:1.0.0` |
###### example
```markdown
`[!!|ghb>release:1.2.1]`
`[!!|ghb>issues:2]`
`[!!|ghb>open issues:0]`
`[!!|ghb>closed issues:2]`
`[!!|ghb>contributors:3]`
`[!!|ghb>license:MIT]`
`[!!|ghs>checks:success]`
`[!!|ghs>build:success]`
```
###### results
### Plain-text
###### syntax
```markdown
`[!!|KEY:VAL]`
```
| syntax | details |
| --------------- | ------------------------------------- |
| \| | start pipe symbol |
| `KEY:VAL` | `KEY` is the type, `VAL` is the value |
###### example
```markdown
`[!!|foo:bar]`
```
###### results
### custom
###### syntax
```markdown
`[!!|ICON|KEY:VAL|COLOR-RGB]`
```
| syntax | details |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| \| | start pipe symbol |
| `ICON` | name of icon. e.g. `lucide-dice` |
| \| | pipe symbol |
| `KEY:VAL` | `KEY` is the type or label, `VAL` is the value text displayed. e.g. `release:1.0.0` |
| \| | pipe symbol |
| `COLOR-RGB`
(optional, defaults to currentColor) | 3 (R.G.B.) numeric (0-255) values, separated by commas. e.g. `144,144,144` or CSS variable e.g. `var(--color-red-rgb)` |
###### example
```markdown
`[!!|message-square|comment:edited by j.d.|var(--color-cyan-rgb)]`
`[!!|dice|roll:eleven|120,82,238]`
`[!!|gem|mineral:emerald|var(--my-custom-rgb)]`
`[!!|apple|fruit:snack|var(--color-red-rgb)]`
`[!!|brain|brain:pkm|var(--color-purple-rgb)]`
`[!!|sun|weather:sunny|var(--color-yellow-rgb)]`
`[!!|cloudy|weather:cloudy|var(--mono-rgb-100)]`
`[!!|sunset|weather:8.44pm|var(--color-orange-rgb)]`
`[!!|dumbbell|reps:3 sets of 50|var(--mono-rgb-00)]`
`[!!|gift|event:wedding|var(--color-blue-rgb)]`
`[!!|plus-square|credit:$100|var(--color-green-rgb)]`
`[!!|minus-square|debit:$10|var(--color-pink-rgb)]`
```
###### results
### Installation
From Obsidian's settings or preferences:
1. [Open in Obsidian.md](obsidian://show-plugin?id=badges)
or:
1. Community Plugins > Browse
2. Search for "Badges"
Manually:
1. download the latest [release archive](https://github.com/gapmiss/badges/releases/download/1.1.0/badges-v1.1.0.zip)
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`
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
### CSS
Custom `CSS` styles can be applied via CSS snippets. All colors and styles can be over-written just the same.
See [CSS snippets - Obsidian Help](https://help.obsidian.md/Extending+Obsidian/CSS+snippets)
##### variables
```css
body {
/* border */
--inline-badge-border-color: transparent;
--inline-badge-border-radius: var(--radius-s);
--inline-badge-border: 1px solid var(--inline-badge-border-color);
/* example custom color */
--my-custom-rgb: var(--color-green-rgb);
}
/* example CSS customization */
.inline-badge[data-inline-badge^="vault"] {
--badge-color: var(--my-custom-rgb);
color: rgba(var(--badge-color), .88);
background-color: rgba(var(--badge-color),.22);
}
```
### Dataview
View and copy example dataview queries: [badges-dataview](assets/badges-dataview.md)
### Development
###### Clone this repo
```bash
cd /path/to/vault/.obsidian/plugins
git clone https://github.com/gapmiss/badges.git
cd badges
```
###### Install packages and run
```bash
npm i
npm run dev
```
###### Enable plugin
1. open `Settings` → `Community plugins`
2. enable the `Badges` plugin.
### Notes
Thanks to [Markdown Furigana Plugin](https://github.com/steven-kraft/obsidian-markdown-furigana) as an example implementation of Live Preview.
[Lucide](https://github.com/lucide-icons/lucide) Icons: https://lucide.dev
Lucide Icons LICENSE: https://lucide.dev/license