Skip to content

Import information about books from your Calibre Library. WIP

License

Notifications You must be signed in to change notification settings

joethei/obsidian-calibre

Repository files navigation

Calibre Importer

Plugin for Obsidian

GitHub package.json version Maintenance min app version libera manifesto

⚠️ This plugin is stil in early development, no guarantees on anything.

This plugin is not related to the other Calibre plugin

Extract data from your Calibre library, Read only.

Read books from your Calibre library directly in Obsidian.

This plugin requires the use of the Calibre content server

Using calibre-web is not supported.

Demo

Search

You can make full use of the Search syntax Calibre offers, see the Documentation for more information.

Templates

You have full access to Nunjucks

You can find the possible variables here(better documentation will follow).

There are also some custom filters added:

  • strip: removes any spaces

The plugin already provides a few of predefined sample templates for you to customize.

Annotations

Calibre does not expose annotation data by default. You need to enable this in the calibre settings.

Open a random book with the calibre viewer, then follow these screenshots:

Enable the Keep a copy of annotations/bookmarks in the e-book file option. If you don't have user accounts configured in calibre put a * in the following field. Put in the username otherwise.

Contributing

GitHub Workflow Status GitHub TeamCity Coverage


If you want to contribute your own template you can do so by creating a Pull Request on src/templating/predefinedTemplates.json