An advanced ebook reader plugin for Obsidian with deep Coffee Shop integration.
Forked from Awesome Reader
- EPUB Support - Full EPUB reading with table of contents
- Reading Progress - Automatically saves and syncs reading position
- Dark Mode - Follows Obsidian theme or manual override
- Scrolled View - Seamless continuous scrolling (EPUB)
- Customizable - Font size and line height settings
- Searchable - Filter books by title instantly
- Currently Reading - Quick access to recent books
- All Books - Browse every EPUB in your vault
- Book Notes - See all your book notes in one place
- One-click actions - Open books, create/open notes
- Highlight counts - See how many highlights per book
- Text Highlighting - Select text and highlight in multiple colors (yellow, green, blue, red)
- Notes - Add notes to any highlight
- Copy to Clipboard - Quick copy selected text
- Export Highlights - Export all highlights to markdown with citations
- Convert to Markdown - Import EPUB books as markdown notes
- Chapter Organization - Each chapter becomes a separate note
- Metadata Preservation - Title, author, and book info in frontmatter
- Index File - Auto-generated table of contents with links
- Centralized Storage - All book notes in
Coffee Shop/Books/ - Auto-generated Content - Metadata, TOC, highlights, Memory links
- Books Index - Auto-maintained index of all books with stats
- Dataview Integration - Queries for related Memory items
- Citation Management - Track chapter and location
- Multiple Formats - APA, MLA, Chicago, or custom templates
- Book Notes - Auto-generate book notes from TOC
- Book Companion - Load books directly into Coffee Shop for AI discussion
- Memory System - Save highlights to Coffee Shop Memory automatically
- Progress Sync - Sync reading position with Book Companion
- AI Actions - Context menu for explain, define, and discuss with AI
- Download the latest release
- Extract to
.obsidian/plugins/coffee-reader/ - Enable in Community Plugins settings
git clone https://github.com/twalderman/obsidian-awesome-reader.git
cd obsidian-awesome-reader
npm install
npm run buildCopy main.js, manifest.json, and styles.css to your vault's .obsidian/plugins/coffee-reader/ folder.
- Click the book icon in the left ribbon to open the Books panel
- Use the search box to filter books by title
- Currently Reading shows your 5 most recent books
- Click a book title to open it
- Click 📝 to open an existing note, or ➕ to create one
- Click 📚 Open Books Index for the full index
- Drop EPUB files into your vault
- Click to open and read
- Reading progress is automatically saved
- Select text in the reader
- Choose a highlight color from the popup menu
- Click the note icon to add a note
- Highlights sync to Coffee Shop Memory (if enabled)
When text is selected:
- 💡 Explain - Send to Coffee Shop for explanation
- 📖 Define - Get word/phrase definition
- ☕ Discuss - Open discussion with AI about the passage
- Right-click any EPUB file → "Import EPUB to Markdown"
- Or use Command Palette: "Coffee Reader: Import EPUB to Markdown"
- Creates a folder with:
- Index file with metadata and TOC
- Individual chapter files as markdown
- Click 📝 in the Books sidebar, or
- Use the book icon in the reader header, or
- Right-click a book file → "Open/create book note"
- Notes are stored in
Coffee Shop/Books/
- Enable in Settings → Coffee Shop Integration
- Right-click book → "Load into Book Companion"
- Discuss the book with AI using your highlights as context
| Setting | Description |
|---|---|
| Display | |
| Scrolled View | Enable continuous scrolling for EPUB |
| Dark Mode | Auto, Light, or Dark |
| Font Size | Reading font size (50-200%) |
| Line Height | Line spacing (1.0-2.5) |
| Coffee Shop | |
| Enable Integration | Connect with Coffee Shop plugin |
| Auto-sync Progress | Sync reading position |
| Highlight to Memory | Save highlights to Memory |
| Book Notes | |
| Book notes folder | Where notes are stored (default: Coffee Shop/Books) |
| Auto-update Index | Keep Books Index current |
| EPUB Import | |
| Save Path | Folder for imported books |
| Create Folders | Subfolder per book |
| Extract Images | Save images from EPUB |
| Citations | |
| Format | APA, MLA, Chicago, or Custom |
| Custom Template | Your citation template |
| Command | Description |
|---|---|
| Import EPUB to Markdown | Convert EPUB to markdown notes |
| Export highlights | Export highlights as markdown |
| Sync highlights to Memory | Bulk sync to Coffee Shop |
| Open Book Companion | Load current book into Coffee Shop |
Coffee Reader emits these events for Coffee Shop integration:
| Event | Description |
|---|---|
coffee-shop:load-book |
Load book into Book Companion |
coffee-shop:sync-progress |
Sync reading position |
coffee-shop:save-memory |
Save highlight to Memory |
coffee-shop:analyze |
Send text for AI analysis |
coffee-shop:context |
Provide reading context |
# Install dependencies
npm install
# Development build (watch mode)
npm run dev
# Production build
npm run build- Original plugin: obsidian-awesome-reader by AwesomeDog
- react-reader for EPUB rendering
- epubjs for EPUB parsing
- turndown for HTML to Markdown conversion
MIT License - see LICENSE for details