An Obsidian.md plugin that syncs highlights from Raindrop.

Overview

Obsidian Raindrop Highlights Plugin (Community Plugin)

Obsidian Raindrop Highlights (Community Plugin) is an unofficial plugin to synchronize Raindrop.io web article highlights/annotations into your Obsidian Vault.

Although there exists a similar project called Obsidian Raindrop Plugin, it hasn't supported pulling highlights/annotations from Raindrop yet, so I decided to develop my own version...

Features

  • Sync web article highlights into Obsidian
  • Sync web article annotations into Obsidian (Raindrop PRO user only)
  • Support nested collections (Raindrop PRO user only)
  • Update existing articles with new highlights and annotations
  • Customization highlights through Nunjucks template
  • Manage Raindrop collections to be synced
  • Auto sync in interval

Usage

After installing the plugin, configure the the settings of the plugin then initiate the first sync manually. Thereafter, the plugin can be configured to sync automatically or manually.

Use Raindrop icon in the sidebar or command Raindrop Highlights: Sync Highlights to trigger manual sync.

Use Raindrop Highlights: Show Last Sync Time command to check last sync time for each collection.

Use Raindrop Highlights: Open Link in Raindrop command to open the corresponding link in Raindrop.

API Token

This plugin doesn't use the OAuth mechanism. To get your API Token, follow the steps:

  1. Access the Integrations section of your Raindrop account
  2. Click "Create new app"
  3. Copy the "Test token"
  4. Paste to the obsidian plugin setting

NOTE: The token is stored using localStorage and it may have conflicts if the same vault were to be open on 2 different windows.

Settings

  • Connect: Enter API Token in order to pull the highlights from Raindrop
  • Disconnect: Remove API Token from Obsidian
  • Auto Sync Interval: Set the interval in minutes to sync Raindrop highlights automatically
  • Highlights folder: Specify the folder location for your Raindrop articles
  • Collection: Specify the collections to be synced to the vault
  • Highlights template: Nunjuck template for rendering your highlights
  • Reset sync: Reset last sync time to resync. This operation does not delete any previously synced highlights from your vault

To sync all new highlights since previous update

  • Use Raindrop icon in the sidebar or Command: Raindrop Highlights: Sync Highlights

NOTE: Do not touch the front matter properties: raindrop_id and raindrop_last_update. These properties are used to identify the existing article to prevent file and highlights duplication.

Acknowledgement

This project is inspired by Hady Ozman's Obsidian Kindle Plugin and Wei Chen's Obsidian Hypothesis Plugin. Lots of features are migrated from their works, big thanks for their efforts!

Limiations

  • To simplify the implementation, this plugin only supports one-way sync. (i.e. from Raindrop to Obsdiain) If you move a file from one folder to another folder, the article's collection in Raindrop remains unchanged. The collection folder inside Obsidian is only used for file creation.
  • Raindrop API has rate limiting, you can make up to 120 requests per minute per authenticated user. This plugin does its best to prevent unneeded requests, it only requests posts updated after the last sync time.
Comments
  • Resync after highlight colour change duplicates highlight

    Resync after highlight colour change duplicates highlight

    • I was wowed to sync in my Raindrop bookmarks, with highlights.
    • Yellow highlights appeared in the bookmark note, in grey callouts.
    • I went back to Raindrop, changed one to green, another to red.
    • I performed a manual sync.
    • These were also synced, but as additions to the bottom of the doc. Original grey (yellow) ones were left in place.
    • More so, I went back to Raindrop and changed them back to yellow, then resynced again.
    • The highlights were added yet again, at the bottom, in grey.
    enhancement 
    opened by robertandrews 8
  • Add YAML ending to template

    Add YAML ending to template

    Hi! Thanks for a great plug! Very useful indeed.

    More of a feature request (optional or not from the user-perspective):

    I would have loved if the YAML block ending (the last "---", after the "raindrop_last_update:" line) was part of the template that I could influence. If it were at the top of the template that I can edit in the modal I could add my own datafields to the YAML block. Currently I don't see a way to do that...or am I missing something somewhere else?

    enhancement 
    opened by hellquist 4
  • Please update documentation with reference of file which stores the API Token

    Please update documentation with reference of file which stores the API Token

    Hi, thanks for making it clear that you store the token (a lot of the other devs don't do that).

    But could you add a reference to the file in which it is stored?

    I guess you do store it in plaintext (which is fine) but this should also be mentioned.

    To many people are sharing their vault and their .obsidian directory 😀

    opened by dredhorse 4
  • can callout headers be the same color as the highlight color?

    can callout headers be the same color as the highlight color?

    Can the callout headers be the same color as the highlight color? As it is with the provided template, (1) red highlights are contained in a callout with a blue header; (2) blue highlights in a callout with a teal color; (3) yellow highlights in a callout with a grey header. Green highlights are okay--in a callout with a green header.

    question wontfix 
    opened by wjfeeney 3
  • Updated description and order of highlights according to the order of the article.

    Updated description and order of highlights according to the order of the article.

    Congratulations. It is a great plugin. I have two questions:

    1. What can I do to make ae update a change in the item description in Raindrop, after I have synced with Obsidian.
    2. Raindrop has a problem that I do not know if you can solve it with this plugin: the order of the highlights is the order of when they are made, but this can give a messy result, since it is very useful the order in which the texts appear in the article, from top to bottom.
    question 
    opened by PentalphaE 3
  • FR: Allow Syncing of

    FR: Allow Syncing of "Bookmarks"

    Would it be possible to sync all "Bookmarks" including Title, Description and tags based on collection and / or tags?

    Everybody is always keen on the highlights, but I'm also looking for an easy way to have some bookmarks in obsidian, with Description and Tags

    At the moment my process is:

    1. Mark a webpage with the raindrop.io plugin, look at the automatic description and make changes if necessary, add tags and collection
    2. Later on during my "triaging" in raindrop.io I take a look if the "bookmark" is still valid and needs either be processed = highlighted or bookmarked (mainly due to the fact that I would probably need to highlight everything or dive deeper into the article and take additional note).
    3. If it is a bookmark I cope the URL and paste that into a "bookmark" note in obsidian, copy the description from raindrop.io and tags and add some more minor comments if necessary.
    4. After processing the "bookmark" in raindrop.io I set a tag that I'm done with it.
    5. Later during my "triaging" in Obsidian I then come back to that bookmark and process it further.
    6. After processing the "bookmark" I tag it as done.

    Being change the process to the following would streamline it a lot:

    1. Mark a webpage with the raindrop.io plugin, look at the automatic description and make changes if necessary, add tags and collection to sync to obsidian
    2. Later during my "triaging" in Obsidian I then come back to that bookmark and process it further.
    3. After processing the "bookmark" I tag it as done in Obsidian and Raindrop.io
    question 
    opened by dredhorse 3
  • "Can't find variable: Buffer"

    On iPad, a previously-authenticated install is reporting "Can't find variable: Buffer".

    My initial setup a few days ago was a little problematic. Initial iPad plugin install (0.0.9) (via BRAT) seemed to work. Then it simply wouldn't pull any bookmarks. I moved to iMac to use Developer Tools to check for messages. It was warning about a problem with the token, so I re-pasted it in, and then pulling bookmarks on iMac worked (and continues to work).

    However, on iPad, with the same Obsidian account etc, synced through iCloud, it throws this error and will not pull new bookmarks. I can only sync successfully on Mac.

    Anything to do with https://github.com/kaiiiz/obsidian-raindrop-highlights-plugin/blob/c1bbec024b9d06338153f03cd91306eb657c509c/yarn.lock#L217 ?

    bug 
    opened by robertandrews 3
  • Highlights template does not accept changes

    Highlights template does not accept changes

    The Highlights template does not accept my changes. I changed the "set callout =" to be "note" (red), "important" (green). However, the default remains: "danger" (red), and "check" (green). What do I need to do to get my callout types?

    question 
    opened by wjfeeney 2
  • Add ability to only sync bookmarks with notes, not all bookmarks regardless of if they have notes or not.

    Add ability to only sync bookmarks with notes, not all bookmarks regardless of if they have notes or not.

    Currently the app doesn't scale very well when dealing with a mix of bookmarks that have highlights and those that do not. For instance if you have 400 bookmarks that contain 50 bookmarks with highlights, and 350 without, instead of providing an option to just download those 50 bookmarks with highlights, you'll instead get 400 bookmarks each downloaded into their own separate folder.

    What makes this worse is that there is no tag or similar to differentiate these files, so you get a big jumbled mess of notes that you now need to sort though in order to figure out which entries had notes, and which ones do not.

    Ideally we should have the option to not download entries that don't contain highlights however if this is not possible then it would be quite helpful to have an option to make the plugin filter out those bookmarks that don't have highlights associated with them and only save the ones that do have highlights into their own files.

    enhancement 
    opened by tekwizz123 2
  • Use raindrop.io tags in Obsidian

    Use raindrop.io tags in Obsidian

    Hi, just tested the plugin and I love it. I also love that it´s possible to get all tags but is it possible to format them so that they are usable and visible in the tag pane? I tried it with renaming "Topics::" to "tags::" and adding a "#" before the tag in the template but that didn´t work. What did work was adding a "#" in front of the tag in raindrop.io, but maybe there is a better solution I´m not aware of. Any ideas? Best Regards

    question 
    opened by Outlawpete285 2
  • Make cache data available to template

    Make cache data available to template

    Added Permanent Copy data so I can link to it if available. Figured others might like that as well.

    • Parses cache ("Permanent Copy") info from the GET response, so it's available to the template renderer.
    • Added it to the template instructions, but not to any defaults, since it requires the Raindrop Pro subscription to be useful.
    Screen Shot 2022-12-25 at 04 11 47

    Example: I think this link only redirects successfully if you're already signed into the Raindrop web app in your browser, but it's pretty convenient for that.

    {% if cache and cache.status === 'ready' -%}
    [Permanent Copy](https://api.raindrop.io/v1/raindrop/{{id}}/cache)
    {%- endif %}
    
    opened by minsley 1
  • Feature Request: Sanitise file name to remove disallowed characters in filenames

    Feature Request: Sanitise file name to remove disallowed characters in filenames

    Hi,

    Thank you for this plugin, I find it incredibly useful! I noticed recently that my mobile version of Obsidian kept crashing on load when indexing the vault and it turns out it is due to there being files with disallowed characters (such as % : ;) and I have tracked these down to Raindrop bookmark titles.

    Would it be possible to add in removal/replacement of disallowed characters? Possibly with the option of specifying a replacement character (e.g. - or _).

    Many thanks :)

    opened by tekiegirl 0
  • Add enable/disable collections folders option

    Add enable/disable collections folders option

    I've added an option to enable/disable the storage of articles in Raindrop collections folders.

    If enabled, it's the default behavior. Else, synced articles will be stored in the root of the highlights folder location, and no collections folders will be created.

    opened by estebanthi 0
  • Metadata Template greyed out

    Metadata Template greyed out

    Hello. Thanks for developing this plugin. I am not a developer so knowledge is limited. In the settings for the plugin the metadata template is greyed out and I am unable to edit. The content template works and I have no issue. Can you suggest a fix for this?

    question 
    opened by HabiusRex 2
  • Field to get the collection title in templates + option to disable collections folders

    Field to get the collection title in templates + option to disable collections folders

    {{collectionTitle}} can be used in templates to get the collection title. I've also added an option to enable/disable the storage of articles in collections folders.

    I needed these two features, so maybe others will need them too?

    It's my first pull request, I'm not sure how it works, maybe I've not done the things the right way.

    opened by estebanthi 1
  • Collection and Link/Page Title

    Collection and Link/Page Title

    Hi,

    how can I make sure I get the collection title in the Frontmatter - {{title}} is used for both the title of the page and the collection name - how do I differntiate those?

    Thanks, Daniel

    documentation 
    opened by renna999 1
Releases(0.0.14)
Owner
You-Kai Zheng
You-Kai Zheng
Obsidian.md plugin to sync highlights/notes from koreader

Obsidian KOReader Plugin Sync KOReader notes in your Obsidian vault. The KOReader device must be connected to the device running obsidian to let the p

Federico Granata 24 Dec 18, 2022
Readavocado obsidian plugin to sync your favorite highlights.

Readavocado Sync Plugin This plugin automatically export your Readavocado highlights into your Obsidian vault. Usage Install the Readavocado Sync Plug

Sarat Limawongpranee 9 Oct 31, 2022
âš¡ Automatically syncs Holy Unblocker to Github from git.holy.how

Holy Unblocker - Cloned to Github from git.holy.how What is the purpose of this repository? Holy Unblocker is self-hosted on git.holy.how. Personally,

IsaacLK 4 Nov 22, 2022
A lambda function mirroring Pixiv bookmarks to Raindrop.io

pixiv-to-raindrop A lambda function that executes automated mirroring of bookmarks from Pixiv to Raindrop.io Demo Source: https://www.pixiv.net/users/

neet lab 2 Oct 13, 2022
A plugin for Obsidian (https://obsidian.md) that adds a button to its search view for copying the Obsidian search URL.

Copy Search URL This plugin adds a button to Obsidian's search view. Clicking it will copy the Obsidian URL for the current search to the clipboard. T

Carlo Zottmann 6 Dec 26, 2022
A solution for highlights extraction for sports games by The Unknowns.

Sportlight by The Unknowns Next.js, Express.js, NLTK, symbl.ai Inspiration - Problem Statement #3 by Experion Technologies Publishing highlights after

Arjun Sivaraman 5 Apr 19, 2022
An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor.

Obsidian Excel to Markdown Table An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor. Demo You can paste the copied Excel d

Ganessh Kumar 108 Jan 4, 2023
This is a plugin for Obsidian (https://obsidian.md). Can open document with `.html` and `.htm` file extensions.

Obsidian HTML reader Plugin This is a plugin for Obsidian (https://obsidian.md). Can open document with .html and .htm file extensions. Obsidian HTML

null 37 Dec 27, 2022
An Obsidian plugin that lets you browse the web within Obsidian.

Obsidian Web Browser An Obsidian plugin that allows you to browse the web within Obsidian using v1.0 tabs. The core functionality of the plugin, rende

Dion Tryban 102 Dec 28, 2022
Obsidian-dataview-table-filter-menu - Dynamically created filter menu for dataview tables in obsidian

Dataview table Filter Menu for Obsidian Dynamically created filter menu for data

shiro 17 Sep 24, 2022
Obsidian-Snippet-collection - A collection of snippet to customize obsidian

This repo is a collection of CSS snippets for Obsidian.md. To install them on PC

Mara 110 Dec 22, 2022
Obsidian Web: Connect your browser with your Obsidian notes

Obsidian Web: Connect your browser with your Obsidian notes This is an unofficial Chrome extension for Obsidian that lets you send content from the we

Adam Coddington 97 Jan 3, 2023
A tool to get plugin statistics of Obsidian plugin ecosystem.

Obsidian Plugin Stats A tool to get plugin statistics of Obsidian plugin ecosystem. Usage You can use this tool to see the plugins that has hit commun

Ganessh Kumar 27 Dec 25, 2022
An obsidian toolbar plugin, modified from the Cmenu plugin

obsidian-editing-toolbar Plugin Thanks to the cmenu plugin, which gave me a lot of inspiration, but this plugin has not been maintained for more than

null 321 Dec 29, 2022
An Obsidian plugin to grab all yaml fields from all files into a dataframe

Metadataframe Metadataframe allows you to get all metadata from your vault into CSV file. With CSV in-hand, you can do any data analysis you want with

null 7 Sep 15, 2022
Hexo-backlink - This plugin is for transfer Obsidian-type backlink to standard hexo in-site post link.

Hexo-Backlink A plugin to convert backlink in .md file to in-site link. Install npm install hexo-backlink configuration Add backlink:true in _config.y

null 8 Sep 27, 2022
An obsidian plugin that creates tomorrows daily note for preemtive planning.

Tomorrow's Daily Note An Obsidian plugin that creates tomorrows daily note for preemtive planning. Requirements Obsidian v0.12.0+. Daily notes plugin

Will Olson 12 Sep 24, 2022
Obsidian plugin to sync Pinboard.in links to Daily Notes

Obsidian Pinboard Sync An Obsidian plugin that adds links you've saved with Pinboard to your Obsidian Daily Notes, synchronizing periodically. Why? I'

Mathew Spolin 35 Dec 1, 2022
A quick capture plugin for Obsidian, all data from your daily notes.

Obsidian Memos 中文文档 A new way for you to quick capture an idea in Obsidian. Which is highly based on the awesome open source project: memos and awesom

Boninall 551 Jan 3, 2023