Sync your reading highlights and notes from Kavita to your Obsidian vault.
This plugin pulls all your annotations, highlights, and notes from Kavita and saves them as a beautifully formatted markdown file in your Obsidian vault. Your highlights become searchable, linkable, and integrated with the rest of your notes.
Example output:
---
tags:
- kavita
- annotations
updated: 2025-12-06T10:30:00Z
---
# Kavita Annotations
## The Great Gatsby
**Author:** [[F. Scott Fitzgerald]]
**Tags:** #kavita/series/the-great-gatsby #kavita/author/f-scott-fitzgerald
### Chapter 1
> In my younger and more vulnerable years my father gave me some advice...
*Note:* This opening is iconic
Page 3
---
> So we beat on, boats against the current...
Page 180- Go to the Releases page
- Download
main.jsandmanifest.jsonfrom the latest release - In your vault, create the folder
.obsidian/plugins/kavita-to-obsidian/ - Copy both downloaded files into that folder
- Restart Obsidian
- Go to Settings → Community Plugins and enable "Kavita to Obsidian"
Once approved, you'll be able to install directly from Obsidian's community plugins browser.
- Open Kavita and log in
- Click your profile icon → User Settings
- Go to 3rd Party Clients
- Copy your API key (or generate one if you don't have one)
- In Obsidian, go to Settings → Kavita to Obsidian
- Enter your Kavita server URL (e.g.,
http://localhost:5000orhttps://kavita.example.com) - Paste your API key
- Adjust other settings as desired
| Setting | What it does | Default |
|---|---|---|
| Kavita URL | Your Kavita server address | - |
| API Key | Your Kavita API key for authentication | - |
| Output Path | Where to save your annotations file | kavita-annotations.md |
| Include Comments | Include your personal notes with highlights | Yes |
| Include Spoilers | Include highlights marked as spoilers | No |
| Include Tags | Generate Obsidian tags from your books | Yes |
| Tag Prefix | Prefix for generated tags | kavita/ |
| Include Wikilinks | Create links to author/series notes | Yes |
Option 1: Click the book icon in the left sidebar
Option 2: Press Ctrl/Cmd + P to open the command palette, then search for "Sync Kavita Annotations"
Your annotations will be saved to the file you specified in settings.
The plugin creates headings for each book, so you can link directly to them from other notes:
See my highlights from [[kavita-annotations#The Great Gatsby]]If you have notes for authors or books, the wikilinks will automatically connect:
**Author:** [[F. Scott Fitzgerald]] ← Links to your author note if it exists- Make sure your Kavita URL is correct and accessible
- Check that Kavita is running
- If using HTTPS, ensure your certificate is valid
- Double-check your API key in Kavita's 3rd Party Clients settings
- Try generating a new API key
- Make sure you have highlights/annotations in Kavita
- Check that "Include Spoilers" is enabled if your annotations are marked as spoilers
Want to help improve the plugin? See CONTRIBUTING.md for development setup and guidelines.
MIT