EpubView

A modern EPUB reader for Visual Studio Code
Explore the repo »

Table of Contents

• Introduction
• Features
• Installation
  • From VS Code Marketplace (Coming Soon)
  • Manual Installation
  • Development Installation
• Usage
  • Keyboard Shortcuts
• Built With
• Why did I build this?
• Contributing
• Wait a minute, who are you?
• License
• Changelog

EpubView lets you read EPUBs in Visual Studio Code. You no longer need to switch between two apps-one app to rule them all!

(back to top)

Please note that EpubView is a basic EPUB reader and any commonly used features found in other readers may be missing or not working as expected.

• 📚 Native EPUB Support - Open and read EPUB files directly in VSCode
• 🔧 Typography Controls - Adjust font family, size, line height, and colors
• 🧭 Interactive Sidebar - Navigate through chapters and sections easily
• ⌨️ Keyboard Navigation - Use arrow keys to navigate between pages
• 💾 Settings Persistence - Your reading preferences are saved automatically
• 📱 Responsive Design - Works well on different screen sizes

(back to top)

ext install Jemeni11.epubview

1. Download the latest .vsix file from Releases
2. Open VSCode
3. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
4. Type "Extensions: Install from VSIX"
5. Select the downloaded .vsix file

git clone https://github.com/Jemeni11/EpubView.git
cd EpubView
pnpm install
pnpm run compile
# Press F5 to launch extension in development mode

(back to top)

1. Open an EPUB file: Use the File Explorer in VSCode to open any .epub file.
2. Start reading: The EPUB will open in a new tab with the default settings.
3. Navigate: Use the sidebar to jump between chapters, or use arrow keys for page-by-page navigation
4. Customize appearance: Use the floating controls to adjust fonts, colors, and text size

• ← Left Arrow: Previous page
• → Right Arrow: Next page
• Ctrl+Shift+P → "EpubView: About & Support": Show extension information

(back to top)

• TypeScript v5
• VSCode Extension API
• epub.js - EPUB parsing and rendering
• JSZip - ZIP file handling for EPUB archives
• esbuild
• ESLint v9

(back to top)

I wanted to read fanfiction in VSCode. That's it. 'Nuff said.

Also, I’ve built other tools in this space like FicRadar, FicImage, TalesTrove and contributed to WebToEpub and Leech.py.

(back to top)

Contributions are welcome! If you'd like to improve EpubView, please feel free to submit a pull request.

(back to top)

Hello there! I'm Emmanuel Jemeni, and I am a Frontend Developer.

You can find me on various platforms:

• LinkedIn
• GitHub
• Bluesky
• Twitter/X

If you'd like, you can support me on GitHub Sponsors or Buy Me A Coffee.

(back to top)

MIT License

(back to top)

Changelog

(back to top)