Skip to content

rezzcode/Epubespiar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

20 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Epubespiar.

  • EPUB Reader Browser Extension

A powerful browser extension for reading EPUB books directly in your browser with a beautiful library management system.

Features

๐Ÿ“– Enhanced Reader

  • Seamless Reading: Read EPUB books with a clean, distraction-free interface
  • Smart Navigation: Easy switching between the library and the reader
  • Table of Contents: Quick navigation through chapters and sections
  • Zoom Controls: Adjust view widths for comfortable reading
  • Font Controls: Adjust text size for comfortable reading
  • Responsive Design: Works great on desktop and mobile devices

๐ŸŽฏ Smart Interactions

  • Drag & Drop: Drop EPUB files onto the reader to open immediately and add to the library

Getting Started

Epubespiar.quick.start.mp4

Architecture

โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚        USER ACTION         โ”‚
โ”‚  Click Extension Icon      โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
             โ”‚ Opens reader page.
             โ”‚
             โ–ผ
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚        USER OPTIONS        โ”‚
โ”‚  (drag-drop / open EPUB)   โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
             โ”‚
             โ–ผ
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚         BROWSER            โ”‚
โ”‚ Fetch EPUB โ†’ detect MIME   โ”‚
โ”‚ (application/epub+zip)     โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
             โ”‚
             โ–ผ
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚  EXT BACKGROUND SCRIPT     โ”‚
โ”‚ webRequest.onHeadersReceivedโ”‚
โ”‚ โ†’ detects EPUB MIME or .epubโ”‚
โ”‚ โ†’ redirects tab             โ”‚
โ”‚     โ†“                       โ”‚
โ”‚ reader.html?file=<url>      โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
             โ”‚
             โ–ผ
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚       READER.HTML          โ”‚
โ”‚ uses epub.js to render     โ”‚
โ”‚ fetches the .epub via URL  โ”‚
โ”‚ displays in tab like PDF   โ”‚
โ”‚ See reading progress %     โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Technical Stack

  • Vue 3: Modern reactive framework for UI
  • epub.js: EPUB parsing and rendering
  • CSS3 & SCSS: For great styling
  • Vite: Fast build tool and development server
  • Manifest V3: Latest Chrome extension API

Development

# Install dependencies
pnpm install

# Development mode
pnpm run dev

# Build for Chrome
pnpm run build:chrome

# Build for Firefox
pnpm run build:firefox

# Build all
pnpm run build

Usage

Instant Reading (EPUB Interception)

The extension automatically intercepts EPUB files anywhere in your browser, just like how browsers handle PDFs:


Note

The full functionality is only available on Chromium browsers since firefox based browsers does not support drag-and-drop local files with the help of an extension, as it does for videos, images, or PDF files

  1. Click EPUB Links: Click any .epub link on a website โ†’ Opens immediately in reader
  2. Navigate to EPUB URLs: Type or paste an EPUB URL โ†’ Opens automatically
  3. Drag & Drop: Drag an EPUB file to any browser tab โ†’ Opens and starts reading
  4. Drag & Drop option 2: Drag drop an EPUB file onto a browser icon โ†’ Opens and starts reading

How it works: The extension uses declarativeNetRequest to detect:

  • URLs ending in .epub
  • Content with MIME type application/epub+zip or application/epub

When detected, it redirects to the extensions reader page, where you can read the document.

Features in Detail

Reader Page

  • Header toolbar with navigation controls
  • Sidebar with table of contents
  • Main reading area with EPUB content
  • Zoom controls for text size

Browser Compatibility

  • Chrome/Edge: Full support
  • Firefox: Full support
  • Other Chromium-based browsers: Should work with the Chrome build

What's not Implemented

  • Epub book library
  • Progress Tracking
  • Url intercepts
  • What you thought was but is not while using the extension

About

A browser extension that lets you open ePub docs right into your browser.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

 
 
 

Contributors