Sync (and resync) your Kindle notes and highlights directly into your Obsidian vault. And create yout Table of Contents (TOCs) for your books. You can choose to sync using one of two methods:
Sync from the cloud any ebooks that you've purchased directly from Amazon. The plugin will screen scrape your highlights from Amazon's Kindle Reader and continuously keep them in sync.
This method will not work for highlights from books, articles, PDFs, and personal documents not purchased from Amazon (see next method).
Sync your highlights by uploading your My Clippings.txt file stored on your Kindle device.
This file includes highlights, bookmarks and notes for any book on your Kindle regardless
if it has been purchased via Amazon.
You can extract your My Clippings.txt file by plugging it into your computer using USB.
-
Continuous, automatic syncing — One button press to sync your highlights using your Amazon account via Amazon's Kindle Reader.
Subsequent syncing will do an intelligent diff and bring in any new highlights without impacting any edits that you've done to your highlights file.
-
Sync non-Amazon books — Sync your highlights by uploading your
My Clippings.txtfile from your Kindle device -
Enriched metadata — Enrich your notes by downloading extra metadata information about your book from Amazon.com
-
Powerful, flexible templating with preview — Customise your highlights and file names to your liking by configuring your own template using (Nunjucks) templating language with live preview
Inspired by Obsidian's principle of "your data sitting in a local folder" and "never leaving you're life's work held hostage in the cloud again", this plugin tries to do exactly that with your precious Kindle notes and highlights. Why should you struggle in accessing your own data, or paying for a third party service to access information that you own?
After enabling the plugin in the settings menu, your Obsidian's status bar will start showing your Kindle sync status. Click on the status bar to start adhoc syncing or to see more detailed information on your sync status to date.
Configure the settings of the plugin to specify the folder location for your syncing.
- Highlights folder: Vault folder to use for plugin to write synced book highlights and notes
- Note template: Template (Nunjucks) to use for rendering your highlights when writing them to disk
- Download book metadata [default: on]: Download extra book metadata from Amazon.com (works for Amazon sync only)
- Sync on startup [default: off]: Enable to always automatically sync your latest highlights using your Amazon account
- Amazon region: Select the Amazon account region which has your Kindle highlights data. Currently only global (.com), India, Japan, Spain, Germany and Italy are supported
- Sign out: Log out from your Amazon account (appears only if you have logged in)
You can start the sync process by clicking on the Kindle icon in the ribbon bar or clicking on the plugin's status bar message at the bottom of Obsidian. You will be presented with a modal that gives you several two options to sync.
Start syncing by choosing between uploading a copy of your My Clippings.txt file or using
your online Amazon account.
- Edit changes in VSCODE and:
cd /vault/.obsidian/plugins/kindtocs
npm run dev
- Test your changes. Go to Obsidian -> Community plugins -> Kindtocs -> Re-enable plugin -> Start sync
| Command | Description | App |
|---|---|---|
git fetch upstream; git pull upstream master |
Update project from original source: https://github.com/hadynz/obsidian-kindle-plugin.git | GIT |
npm update |
Update Node libraries | VSCODE |
npm run dev |
Create main.js and dist files for Obsidian. |
VSCODE |
npm run test |
Run all tests | VSCODE |
npm test -- ./src/suma |
Run specific test: suma.spec.ts | VSCODE |
sudo npm install -g npm@8.3.0 |
Update npm core to 8.3.0 - the "npm -v" new version) | VSCODE |
| Tag | Description | Present |
|---|---|---|
{{text}} |
Annotated text | Always in all sync modes |
{{location}} |
Highlighted text location | Usually available in all sync modes. If not, then {{page}} will be available |
{{page}} |
Highlighted text page | Usually available in all sync modes. If not, then {{location}} will be available |
{{note}} |
Associated note to highlight | Optional |
{{appLink}} |
Link to open highlight in Kindle app | Available only for Amazon books synced through Amazon online |
{{color}} |
Color of the highlight (pink, blue, yellow, orange) | Available only for Amazon books synced through Amazon online |
If you choose to sync your highlights via Amazon's online Kindle Reader, it is important to note that by logging in to your Amazon account via Obsidian your Amazon session becomes available to any other plugin across your vaults until your session expires.
You can mitigate this risk by logging out after every sync (from settings) or using the offline
method of syncing by uploading your My Clippings.txt file instead.
If you like this plugin and would like to buy me a coffee, you can!
