README file from
GithubInline Annotations for Obsidian
Add short notes to any text without creating a full page. Select a word or sentence, attach an annotation, and reveal it with a click or hover.
Perfect for TTRPG notes, study material, manuscripts, or anywhere you want hidden context on specific phrases.
https://github.com/user-attachments/assets/c38f869e-3c93-4b8f-a1c9-a2f25313c1a6
How it works
Write annotations inline using the {text::note} syntax:
The party finds a {locked chest::DC 15 — on failure, the mechanism jams}.
In reading view and live preview, only locked chest is visible. Click (or hover) to see the note in a popup above the text.
Usage
Create an annotation
- Select text in the editor
- Run Annotate selection from the command palette (
Ctrl/Cmd + P), or right-click and choose Annotate selection
View an annotation
- Click mode (default) — click the annotated text to show the popup, click elsewhere to dismiss
- Hover mode — hover over the text, popup disappears when you move away
Edit or remove
Right-click any annotation in the editor to get Edit annotation or Remove annotation options.
Settings
| Setting | Options | Description |
|---|---|---|
| Trigger mode | Click / Hover | How annotation popups are revealed |
Installation
From Obsidian Community Plugins
- Open Settings → Community plugins → Browse
- Search for Inline Annotations
- Click Install, then Enable
Manual
- Download
main.js,manifest.json, andstyles.cssfrom the latest release - Create a folder
inline-annotationsin your vault's.obsidian/plugins/directory - Place the three files inside it
- Enable the plugin in Settings → Community plugins
Development
npm install
npm run dev # watch mode
npm run build # production build