Book Highlights Importer

by Evgeniy Yadlovskiy
5
4
3
2
1
Score: 50/100

Description

Reviews

No reviews yet.

Stats

0
stars
14
downloads
0
forks
8
days
1
days
8
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
69
commits

Latest Version

9 days ago

Changelog

Patch release for Obsidian plugin review compliance.

README file from

Github

Book Highlights Importer

Plugin version 0.1.1 Minimum Obsidian version 1.13.0 MIT license

Book Highlights Importer is an Obsidian plugin that imports highlights and comments from Yandex Books into Markdown notes.

Book Highlights Importer demo

Watch the plugin demo GIF

Features

  • Search your authenticated Yandex Books library by title or author.
  • Browse books grouped as In progress, Finished, and Unread or unknown.
  • Import one book's highlights and comments through Provider > Book > Destination.
  • Choose a Vault-relative folder and filename, with a configurable default folder.
  • Replace only the plugin-owned Managed Section on re-import while preserving user Markdown and unrelated properties.
  • Run on Obsidian desktop and mobile, version 1.13.0 or newer.

Installation

Manual installation

To build and install a development version manually:

  1. Clone this repository.
  2. Run npm ci.
  3. Run npm run build.
  4. Create <vault>/.obsidian/plugins/book-highlights-importer/.
  5. Copy dist/main.js, dist/manifest.json, and dist/versions.json into that directory.
  6. Reload Obsidian.
  7. Open Community plugins in Obsidian's settings and enable Book Highlights Importer.

Community Plugins

Search for Book Highlights Importer in Obsidian's Community Plugins browser, then install and enable it.

Setup

  1. Open Settings > Book Highlights Importer.
  2. Optionally set the Default import folder.
  3. Select Get Yandex OAuth token.
  4. Authorize access in the external browser.
  5. Copy the y0_... value from the browser URL.
  6. Paste the value into the token field and save it.
  7. Select Test connection.

[!WARNING] Keep your Yandex OAuth token secret and treat it as a password.

Usage

  1. Run the Import Book Highlights command.
  2. Select Yandex Books as the Reading Provider.
  3. Search for and choose one book.
  4. Confirm the destination folder and filename.
  5. Select Import.

The default filename is Author - Title.md. After a successful import, the plugin attempts to open the destination Managed Book Note.

Generated notes

Each generated Managed Book Note includes these properties:

  • bh-provider: the source provider.
  • bh-book-id: the provider's book identifier.
  • bh-title: the book title.
  • bh-authors: the book's authors.
  • bh-imported-at: the import timestamp.

Highlights are rendered as blockquotes, and comments are rendered as [!note] Comment callouts. Imported content is enclosed in a marker-delimited Managed Section.

Re-import replaces the Managed Section from the latest provider snapshot and removes annotations the provider no longer returns. It preserves all content outside that section and unrelated properties. To protect existing notes, the plugin refuses to overwrite unmanaged notes, notes with malformed managed markers, or notes identified as a different provider or book.

Limitations

  • Yandex Books is the only supported Reading Provider.
  • Imports are explicit and handle one book at a time; there is no background sync.
  • There are no custom templates.
  • Importing the same book to another path can create another Managed Book Note.
  • Identical Yandex quote rows are preserved because stable quote identifiers are unavailable.

Security and privacy

The Yandex OAuth token is stored through Obsidian Secret Storage and is not redisplayed. It can be replaced or cleared and must be treated as a password.

Development

Development requires Node.js ^20.19.0 || ^22.13.0 || >=24.

npm ci
npm run build
npm run check

Support and contributing

Use the GitHub issue tracker to report bugs or request features. Contributors should discuss substantial changes in an issue before opening a pull request.

License

Book Highlights Importer is licensed under the MIT License.

Disclaimer

This plugin is unofficial, is not affiliated with or endorsed by Yandex or Obsidian, and may be affected by changes to Yandex services.