summaryrefslogtreecommitdiff
path: root/Home.md
blob: 8ce3c040f0a5fd4ac4222c1db07bd310d1bd119d (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
39
40
## web EPUB reader using EPUB.js, Bootstrap, and Calibre

* responsive design
* has transparent offline mode via service workers
* can optionally store files locally for later reading
* supports word definition lookups using dictd
* supports Chrome homescreen "app mode"
* has several color themes

### 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?3"><img src="https://tt-rss.org/images/epube/reader2_small.png?4"></a>

* https://tt-rss.org/images/epube/library2.png (mobile)
* https://tt-rss.org/images/epube/reader1.png (desktop)
* https://tt-rss.org/images/epube/reader3.png (settings)

### 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

See [README.md](https://git.tt-rss.org/fox/the-epube/src/master/README.md)

### FAQ

#### Fonts and/or styles are weird inside the book
Epub contents usually have inline style information which overrides settings applied by The Epube and therefore needs to be removed.

The easiest way to do this properly is converting the file (epub to epub) while filtering the following in Calibre using conversion options (``Look & feel`` &rarr; ``Styling``): 

1. check ``Fonts`` category
2. add ```font-size, line-height``` to *Other CSS properties*.

#### 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.