An open API service indexing awesome lists of open source software.

https://github.com/qvanphong/calibre-opds-obsidian

A plugin that integrate calibre-web into Obsidian
https://github.com/qvanphong/calibre-opds-obsidian

calibre-web obsidian-plugin

Last synced: 11 months ago
JSON representation

A plugin that integrate calibre-web into Obsidian

Awesome Lists containing this project

README

          

# Calibre-web Obsidian integration
Integrate you [Calibre-web](https://github.com/janeczku/calibre-web) into Obsidian for Read & Note workflow

![demo](https://github.com/qvanphong/calibre-web-obsidian/blob/docs/public/demo.gif)
## ✨ Features:
- Browse your Calibre-web right in Obsidian
- Read PDF & Epub with tiny space
- Integrated with PDF++ for an excel PDF reading experience
- Built-in EPUB Reader
- Theme setting

## 🚀 Installation

### Manual Installation
1. Download the latest release from the [GitHub releases page](https://github.com/qvanphong/calibre-web-obsidian/releases)
2. Extract the files to your `.obsidian/plugins/calibre-web/` folder
3. Enable the plugin in Obsidian's Community Plugins settings

### BRAT
1. Install BRAT from the [BRAT's Github page](https://github.com/TfTHacker/obsidian42-brat)
2. In BRAT setting, add Calibre-web Obsidian plugin repo into (https://github.com/qvanphong/calibre-web-obsidian)
3. Choose wanted version & enjoy ;)

### From Obsidian Community Plugins (Coming Soon)

## Want to use with Calibre instead of Calibre-web?
I got your back ;)

- First, setting your calibre content server, don't forget to force to use username & password for security
- ‼️ Go to **Preference** -> **Sharing over the net** -> **Advanced** -> **Choose the type of authentication used** to **basic**
- Copy the necessaries information like: **Content Server URL, Username & Password**
- Add it into the **Calibre-web Obsidian** in Obsidian's setting
- Enjoy

## Be aware
This plugin might expose your Calibre-web username & password to your internet history & through your vault, make sure you are having your Calibre-web in secure (through VPN or something like that)

## Roadmap
### Calibre Web Browser UI
- [ ] Customize Grid/List view

### Epub Viewer
- [ ] Enhance mobile navigation experience
- [ ] Dummy EPUB file
- [ ] File-based database for EPUB highlights
- [ ] Highlight for EPUB reader