blob: 6b3f2ec2b27899a139c13ef1a41e20b211cae584 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
## The Epube
Self-hosted web EPUB reader using EPUB.js, Bootstrap, and Calibre
* responsive design
* fully supports offline mode
* integrates with Calibre library
* multi-device sync of last-read pages (when online)
* word definition lookups using dictd / Wiktionary
* supports Chrome homescreen "app mode"
* optional hyphenation using [hyphen](https://github.com/ytiurin/hyphen) library
* various themes, etc
See also:
* [Android client (wrapper)](https://git.tt-rss.org/fox/the-epube-android)
* [Demo](https://srv.tt-rss.org/books/) (login as <code>demo</code>, <code>demo</code>; database is restored every three hours)
### Screenshots
<a href="https://tt-rss.org/images/epube/library1.png?2"><img src="https://tt-rss.org/images/epube/library1_small.png?3"></a> <a href="https://tt-rss.org/images/epube/reader2.png?4"><img src="https://tt-rss.org/images/epube/reader2_small.png?5"></a>
### UI cheat sheet
* Switch pages: Left, Right, Mouse wheel, swipe left/right, space, taps/clicks on left and right sides of the window
* Show UI if it's hidden: escape or tap somewhere in the middle of reader window
* Dictionary lookup: double click/select one word
### Installation
* Using Docker compose: https://git.tt-rss.org/fox/epube-docker-compose (not entirely automated, need to edit `config.php`)
* Host installation, see [README.md](https://git.tt-rss.org/fox/the-epube/src/master/README.md)
### FAQ
#### Moving between pages is slow with some books
This happens sometime on slow devices, i.e. phones. The usual reason is Epub chapters are too large. Those can be split into smaller sections with Calibre epub converter: *EPUB Output -> Split files larger than ->* set a smaller value, 100KB should be fine.
|
