Note Highlight

Note Highlight

Note Highlight is an Obsidian plugin that renders square-bracket planning tags such as [now], [trap], and [suggestion] as readable badges.

It is designed for lightweight planning notes, research logs, and review documents where short inline status tags should remain plain Markdown while becoming easier to scan in Obsidian.

Features

• Renders known [tag] markers as badges in Reading View.
• Renders the same badges in Live Preview / editor view.
• Adds a subtle left accent to tagged headings, list items, paragraphs, and editor lines.
• Keeps the original Markdown unchanged.
• Ignores Obsidian native callouts such as [!note].

Supported Tags

[now], [plan], [next], [fact], [data], [solution], [trap], [drop], [question], [paper], [check], [review], [quarter], [risk], [suggestion], [note]

Tags are case-insensitive, so [NOW] and [now] are rendered the same way.

Manual Install

1. Build the plugin:

   npm install
   npm run build
   

2. Copy these files into your vault plugin folder:

   .obsidian/plugins/note-highlight/
   

   Required files:

   main.js
   manifest.json
   styles.css
   

3. Reload Obsidian and enable Note Highlight in Community Plugins.

Development

npm install
npm run test
npm run type-check
npm run build

There is also a browser-only preview page for quick visual checks:

tests/render-preview.html

Release Checklist

1. Update manifest.json, package.json, and versions.json to the same plugin version.

2. Run:

   npm run test
   npm run type-check
   npm run build
   

3. Commit the source code.

4. Create and push a Git tag that exactly matches the version in manifest.json, for example 0.1.2.

5. Let the Release GitHub Actions workflow build, upload, and attest main.js, manifest.json, and styles.css.

Do not manually upload release assets unless you also generate artifact attestations for those exact files.

To repair an existing release that was uploaded manually, run the Release workflow with workflow_dispatch and enter the existing tag, for example 0.1.2. The workflow will rebuild the assets from that tag, upload them with --clobber, and generate GitHub artifact attestations.

License

MIT