Skip to content

Extension Badge Messages

Adam Coddington edited this page Feb 11, 2024 · 4 revisions

image

When enabled, Obsidian Web will decorate its icon in your extension toolbar when finding that the URL you are visiting is owned by a note (see Page Notes) or the URL you are visiting has been mentioned on a note. By default this badge will show a count of how many matches were found and will show the badge background in either yellow or blue depending on whether a dedicated note was found or the URL was found to be just mentioned on a note. You can fine-tune how the badge is displayed, though, using particular frontmatter fields:

web-badge-color

image

This sets the color to display the badge in when landing on a URL owned by this page. This should be a hexadecimal value, and given that frontmatter is YAML and the # field starts a comment, this must be quoted. E.g. "#FF00FF". By default, the badge is shown in gold (or blue, if the URL is only mentioned on a non-URL-owned page).

web-badge-message

image

Sets a message to display when landing on a URL owned by this page. The badge only allows for very short messages -- just maybe four characters -- so you will have to be brief. By default, the message will contain the count of matching pages.

Example

---
url: https://www.apartments.com/the-draper-chicago-il/6b7k8cs/*
web-badge-message: NICE
web-badge-color: "#FF00FF"
---