https://github.com/caronchen/obsidian-epub-plugin

An ePub reader plugin for Obsidian.
https://github.com/caronchen/obsidian-epub-plugin

Last synced: 5 months ago
JSON representation

An ePub reader plugin for Obsidian.

• Host: GitHub
• URL: https://github.com/caronchen/obsidian-epub-plugin
• Owner: caronchen
• License: mit
• Created: 2022-04-29T06:31:06.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-22T14:30:28.000Z (over 1 year ago)
• Last Synced: 2024-08-13T07:17:56.368Z (8 months ago)
• Language: TypeScript
• Homepage:
• Size: 27.3 KB
• Stars: 88
• Watchers: 2
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - caronchen/obsidian-epub-plugin - An ePub reader plugin for Obsidian. (TypeScript)

README

        
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/caronchen/obsidian-epub-plugin) ![GitHub all releases](https://img.shields.io/github/downloads/caronchen/obsidian-epub-plugin/total) ![GitHub Release Date](https://img.shields.io/github/release-date/caronchen/obsidian-epub-plugin) ![GitHub last commit](https://img.shields.io/github/last-commit/caronchen/obsidian-epub-plugin)

## Obsidian ePub Reader Plugin

This is an ePub reader plugin for Obsidian (https://obsidian.md). Can open document with `.epub` file extension.

- [Obsidian ePub Reader Plugin](#obsidian-epub-reader-plugin)

  - [How to use](#how-to-use)

    - [1. Put books into any vault folder](#1-put-books-into-any-vault-folder)

    - [2. Click book to open an epub view](#2-click-book-to-open-an-epub-view)

    - [3. Reading](#3-reading)

  - [Manually installing the plugin](#manually-installing-the-plugin)

### How to use

#### 1. Put books into any vault folder



#### 2. Click book to open an epub view

![687BE408-BC9A-4AAC-915F-2CA77DE6516D](https://user-images.githubusercontent.com/150803/166110865-bcf2bade-f88b-40b9-855d-cffbd115132d.png)

#### 3. Reading

![DD6C75EE-3805-43FE-9A86-4CFDF88DBB75](https://user-images.githubusercontent.com/150803/166111153-637ed20c-c49d-4c75-90b8-14ebf4e30172.png)

**TOC**

![260FB389-0503-488B-860D-3535A4F7CACF](https://user-images.githubusercontent.com/150803/166111158-cde58136-8a8a-4d93-96bf-14b7d3f80ab2.png)

### Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/obsidian-epub-plugin/`.