Skip to content

shibotto/foliate

 
 

Repository files navigation

Foliate

A simple and modern GTK eBook viewer, built with GJS and Epub.js.

View

Website: https://johnfactotum.github.io/foliate/

Features

  • View EPUB files
  • Two-page view and scrolled view
  • Customize font and line-spacing
  • Light, sepia, dark, and invert mode
  • Reading progress slider with chapter marks
  • Bookmarks and annotations
  • Find in book
  • Quick dictionary lookup
  • Touchpad gestures: use two-finger swipe to turn the page

Installation

Flatpak

Download on Flathub

Distribution packages

For Arch Linux users, two packages are available on the AUR: foliate (stable version), foliate-git (Git version)

For Void Linux users, foliate is available in Void's official repository. Install using xbps: xbps-install -S foliate

For Fedora users, foliate is available in Fedora's official repository. Install using DNF: sudo dnf install foliate

Optional dependencies

Auto-hyphenation is done using CSS hyphenation. To enbale CSS hyphenation in WebKitGTK, you will need to install the hyphenation rules, e.g., hyphen-en for English, hyphen-fr for French, etc.

Install manually from source

First, you'll need the following dependencies:

  • gjs
  • webkit2gtk
  • libsoup
  • meson
  • gettext

Then run the follwing commands:

meson build --prefix=/usr
cd build
ninja
sudo ninja install

To uninstall, run:

sudo ninja uninstall

Build and run from source without installing

You will need the same dependencies listed in this section.

The following commands will build Foliate and install it inside a directory:

meson build --prefix=$PWD/fakeprefix
ninja -C build
ninja -C build install
GSETTINGS_SCHEMA_DIR=$PWD/fakeprefix/share/glib-2.0/schemas ./fakeprefix/bin/com.github.johnfactotum.Foliate

Screenshots

Dictionary:

Lookup

Annotations:

Note

Annotations

Find in book:

Find

Dark mode:

Dark

Book metadata display:

About


Note: three JavaScript libraries are bundled in this software:

  • Epub.js, which is licensed under FreeBSD. The included file is patched to fix futurepress/epub.js#942
  • The minified version of JSZip, which is dual-licensed. You may use it under the MIT license or the GPLv3 license. See LICENSE.markdown
  • A browserified version of Cheerio, which is licensed under MIT. Cheerio is used to parse and extract data from Wiktionary

About

A simple and modern GTK eBook reader

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.6%
  • HTML 1.2%
  • Other 0.2%