obsidian-plugin/gapmiss_badges
1
0
Fork 0
mirror of https://github.com/gapmiss/badges.git synced 2026-07-22 08:00:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify icon name requirements for custom syntax

Browse source 
Documents that custom syntax requires actual Lucide icon names,
while standard syntax supports both built-in aliases and Lucide names.

Closes #11

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@gapmiss 2026-05-26 17:22:58 -05:00
parent df755b9259
commit 88ab8604fc
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -149,7 +149,7 @@ For example, `[!!success]` displays as "Success" with a checkmark icon. This wor
| syntax | details |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| <code>\|</code> | start pipe symbol |
| `ICON` | name of icon. e.g. `lucide-dice` |
| `ICON` | [Lucide icon](https://lucide.dev/icons/) name. e.g. `dice` or `lucide-dice` |
| <code>\|</code> | pipe symbol |
| `KEY:VAL` | `KEY` is the type or label, `VAL` is the value text displayed. e.g. `release:1.0.0` |
| <code>\|</code> | pipe symbol |
@ -165,6 +165,9 @@ For example, `[!!success]` displays as "Success" with a checkmark icon. This wor
> `[!!|tag|:Release 1.2.1]`
> ```
> [!IMPORTANT]
> Custom syntax requires actual [Lucide icon](https://lucide.dev/icons/) names (e.g., `pen-tool`, `message-square`). The built-in aliases like `notice` or `success` only work with standard syntax. For example, use `[!!|pen-tool|notice:text|color]` not `[!!|notice|notice:text|color]`.
###### example
```markdown