README file from
Github"Tag to Readwise" Obsidian plugin
An Obsidian plugin that syncs all blocks tagged with a certain tag to Readwise as highlights.
⚠️ NOTE: If you want to sync your highlights from Readwise to Obsidian, use the official Readwise plugin for Obsidian. This plugin does the opposite: syncs your own notes into Readwise so you can review them as "highlights".
This plugin is not built or endorsed by Readwise. I am just an avid Readwise user, and this is just a hobby project I use to review my personal notes about focus-first technology and other topics. :)
Features
- Syncs all blocks tagged with
#review(or a different tag of your choosing) into Readwise as highlights. - By default, syncs only the notes that have changed since the last sync.
- Readwise's "View Original highlight" action will take you straight to the note in your Obsidian vault (using an
obsidian://URL). The plugin adds a block ID to all tagged blocks to enable this deep linking (something like^abc123at the end of the line).
Setup
- Copy
manifest.jsonandmain.js(built fromsrc/main.ts) into<your-vault>/.obsidian/plugins/tag-to-readwise/. - Reload Obsidian and enable the plugin under Settings → Community plugins.
- Open the plugin settings and paste in your Readwise API token (find it at https://readwise.io/access_token). Click "Validate" to confirm it works.
- Set the book title and author in the plugin settings. Optionally change
the tag name (default
review), the Readwise category assigned to the highlights, or toggle whether automatic syncs happen on vault load (enabled by default).
Usage
- Command palette → "Sync all #review blocks to Readwise" (syncs files modified since the last synced time)
- Command palette → "Re-sync ALL highlights to Readwise" (ignores the last synced time and syncs all files)
- Command palette → "Sync #review blocks in current file to Readwise"
- Or click the "book with up arrow" icon in the ribbon (leftmost sidebar on desktop)
⚠️ WARNING: If you rename or move a note in Readwise, any already-synced highlights from that note will be duplicated in Readwise, because the highlight URL will be different. Deleting the ^abc123 marker from a synced block has the same effect, since a new ID gets generated next time it's scanned.