EPUB Reader for VS Code

A Visual Studio Code extension that allows you to read EPUB files directly in the editor.

Features

• 📖 Native EPUB Support: Open and read EPUB files directly in VS Code
• 📑 Chapter Navigation: Browse through chapters using the sidebar
• 🎨 Clean Reading Interface: Optimized for comfortable reading experience
• 🌙 VS Code Theme Integration: Automatically adapts to your VS Code theme
• ⌨️ Keyboard Navigation: Use Previous/Next buttons to navigate chapters
• 📚 Metadata Display: Shows book title, author, and chapter information
• 🔍 Auto-Detection: Automatically opens EPUB files with the reader

Screenshots

Screenshots will be added here showing the extension in action

Installation

From Source

1. Clone or download this extension

2. Install dependencies:

   cd epub-reader-vscode
   npm install
   

3. Compile the TypeScript:

   npm run compile
   

4. Install the extension:

   • Open VS Code
   • Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
   • Type "Extensions: Install from VSIX"
   • Navigate to the extension folder and select the generated .vsix file

Development

1. Open the extension folder in VS Code
2. Press F5 to launch a new Extension Development Host window
3. Open an EPUB file to test the extension

Usage

Opening EPUB Files

1. Automatic: Simply click on any .epub file in the VS Code explorer
2. Context Menu: Right-click on an .epub file and select "Open with EPUB Reader"
3. Command: Use Ctrl+Shift+P and search for "Open with EPUB Reader"

Reading Interface

• Sidebar: Shows book title, author, and chapter list
• Main Content: Displays the selected chapter content
• Navigation: Use Previous/Next buttons or click chapters in the sidebar
• Responsive: Adapts to your VS Code theme and window size

Supported Features

• ✅ EPUB 2.0 and 3.0 format support
• ✅ Chapter navigation and table of contents
• ✅ HTML content rendering
• ✅ Metadata extraction (title, author)
• ✅ VS Code theme integration
• ✅ Keyboard navigation

Limitations

• Images may not display if they use relative paths
• Complex CSS styling might not render perfectly
• No support for interactive EPUB features
• No bookmarking or annotation features (yet)

Development

Building

npm run compile

Watching for Changes

npm run watch

Package Extension

vsce package

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

License

MIT License - see LICENSE file for details

Changelog

1.0.0

• Initial release
• Basic EPUB reading functionality
• Chapter navigation
• VS Code theme integration