Skip to content

An Obsidian.md plugin that syncs highlights from Hypothesis.

License

Notifications You must be signed in to change notification settings

bcdax110/obsidian-hypothesis-plugin

 
 

Repository files navigation

Obsidian Hypothesis Plugin (Community Plugin)

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

Features

  • Sync web article highlights/annotations on Obsidian startup or manual trigger
  • Update existing articles with new highlights and annotations
  • Customization highlights through Nunjucks template

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 Hypothesis icon on the side icon ribbon or command to trigger manual sync.

Settings

  • Connect: Enter API Token in order to pull the highlights from Hypohesis
  • Disconnect: Remove API Token from Obsidian
  • Auto Sync Interval: Set the interval in minutes to sync Hypothesis highlights automatically
  • Highlights folder: Specify the folder location for your Hypothesis articles
  • Use domain folders: Group generated files into folders based on the domain of the annotated URL
  • Sync on startup: Automatically sync highlights when open Obsidian
  • Highlights template: Nunjuck template for rendering your highlights
  • Groups: Add/remove group to be synced
  • Reset sync: Wipe your sync history. Does not delete any previously synced highlights from your vault

To sync all new highlights since previous update

  • Click: Hypothesis ribbon icon
  • Command: Sync new highlights
  • Command: Resync deleted file

    (Note: Files synced before v0.1.5 will need to reset sync history and delete all synced files to have this feature work properly)

Limitations & caveats

  • Limit to 1000 highlights on initial sync for performance. Subsequent sync for deltas are capped at 200 as pagination of result sets does not work in conjunction with API search_after parameter.
  • Only tested with Obsidian Mac OSX and Windows 10.
  • Does not suport annotations on PDFs.

Acknowledgement

This project is inspired by Hady Ozman's Obsidian Kindle Plugin.

Do you find this plugin useful?

Thank you for your support 🙏

About

An Obsidian.md plugin that syncs highlights from Hypothesis.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 82.7%
  • Svelte 9.1%
  • HTML 3.3%
  • JavaScript 3.1%
  • Nunjucks 1.8%