Skip to content

A koreader to logseq syncing plugin. Reference and read annotations in your notebook.

License

Notifications You must be signed in to change notification settings

isosphere/logseq-koreader-sync

Repository files navigation

Logseq Koreader Sync

A KOReader to Logseq syncing plugin

This is a tool to import your annotations from KOReader in a read-only format - this is a one directional synchronization1. It is not affiliated with the KOReader project.

The _logseq-koreader-sync page generated by this plugin are intended to be read-only.

However, the blocks are intended to be freely referenced elsewhere in your graph. Their UUIDs should not change.

As of this writing, it is working and I think useful, but there may be bugs I have not noticed. Please raise an issue if you find one.

🚀 Features

  • Import annotations from a KOReader metadata folder containing "*.sdr" folders with metadata.*.lua files.
  • Blocks imported by the sync persist despite future syncs - references should remain stable

🛠️ Usage

  1. Install the plugin from the Logseq marketplace, in-app
  2. Pin the "koreader-sync" icon to your Logseq toolbar
  3. Press the "koreader-sync" icon on your toolbar, and when prompted locate your KOReader metadata directory
  4. Reference the created blocks, but don't alter them.

I use Syncthing on Android to ensure that I have a local copy of my metadata.

demo animation

Footnotes

  1. perhaps one day we can do bidirectional synchronization, but that sounds like a very difficult task right now.