Obsidian Stats logoObsidian Stats

Quick Reads Sync

by mattbirchler
5
4
3
2
1
Score: 26/100
Install Code

Description

The official Obsidian plugin for Quick Reads

Reviews

No reviews yet.

Stats

3
stars
354
downloads
1
forks
91
days
6
days
6
days
6
total PRs
2
open PRs
2
closed PRs
2
merged PRs
3
total issues
3
open issues
0
closed issues
30
commits

Latest Version

1.0.6
6 days ago

Changelog

This release fixes two bugs that could stop the plugin from syncing at all. If your syncs have been failing with "Folder already exists," this fixes it and no action is needed on your part beyond updating.

Fixed:

  • The Highlights folder setting now saves. Previously, neither typing a folder name nor picking one from the suggestion list was ever written to disk, so the plugin silently kept using the default folder no matter what you chose.
  • Syncing no longer fails when your folder name differs only in capitalization. On macOS and Windows, a setting of "quick reads" did not match an existing "Quick Reads" folder, so the plugin tried to create a folder that was already there and the sync failed before writing a single note. Folder names are now matched without regard to case, and notes are filed using the folder's real name.
  • Leading and trailing spaces or slashes in the folder setting are now cleaned up instead of causing surprises.
See all version on GitHub

README file from

Github

Quick Reads sync for Obsidian

Sync your Quick Reads highlights into Obsidian notes.

Features

  • Imports highlights from your Quick Reads account.
  • Groups highlights by article and creates one note per article.
  • Appends new highlights to existing article notes.
  • Supports automatic sync on startup and at a configurable interval.
  • Includes a customizable note template with placeholder tags.

Requirements

  • Obsidian 1.6.6 or newer
  • A Quick Reads API key from https://quickreads.app/settings

Setup

  1. Install and enable Quick Reads sync in Obsidian.
  2. Open plugin settings.
  3. Paste your API key.
  4. Choose a destination folder for imported highlights.
  5. (Optional) Enable startup sync or set an auto-sync interval.

Command and actions

  • Command palette: Sync highlights from Quick Reads
  • Ribbon icon: Sync Quick Reads highlights
  • Settings button: Sync

Note template placeholders

You can customize the note template using:

  • {{articleId}}
  • {{articleTitle}}
  • {{author}}
  • {{siteName}}
  • {{url}}
  • {{highlights}}

Behavior details

  • The plugin tracks synced highlight IDs to avoid duplicate imports.
  • If a note already exists for an article, newly fetched highlights are appended.
  • If no new highlights are available, the plugin records the sync time and exits.

Troubleshooting

  • If sync fails, verify your API key in plugin settings.
  • Confirm your vault has permission to create notes in the selected folder.
  • Check Obsidian developer console logs for API or network errors.

Development

  • Install dependencies: npm install
  • Build: npm run build
  • Dev build/watch: npm run dev

License

This project is licensed under the MIT License. See LICENSE.

Sponsors