+1
Daily
8,880
stars
438
forks
68
watchers
396
prs
1,224
issues
35
releases
README
Foliate Read books in style. !Screenshot Installation Run Time Dependencies - gjs (= 1.82) - gtk4 (= 4.12) - libadwaita (= 1.8; gir1.2-adw-1 in Debian-based distros) - webkitgtk-6.0 (webkitgtk6.0 in Fedora; gir1.2-webkit-6.0 in Debian-based distros) Optional Dependencies To enable auto-hyphenation, you will need to install hyphenation rules, e.g., hyphen-en for English, hyphen-fr for French, etc. (which strictly speaking are optional dependencies for WebkitGTK, not Foliate itself). For text-to-speech support, install speech-dispatcher and output modules such as espeak-ng. If installed, tracker (= 3; gir1.2-tracker-3.0 in Debian-based distros) and tracker-miners can be used to track the locations of files. Obtaining the Source The repo uses git submodules. Before running or installing, make sure you clone the whole thing with --recurse-submodules: git clone --recurse-submodules https://github.com/johnfactotum/foliate.git Or download the tarball (the .tar.xz file) from the Releases page. Run without Building or Installing It's possible to run directly from the source tree without building or installing. Simply run gjs -m src/main.js This can be useful if you just want to quickly try out Foliate or test a change. But note that this will run it without using GSettings, so settings will not be saved. To solve this, you can compile the schema by running glib-compile-schemas data Then you can set the schema directory when running the app: GSETTINGS_SCHEMA_DIR=data gjs -m src/main.js Building and Installing from Source The following dependencies are required for building: - meson (= 0.59) - pkg-config - gettext To install, run the following commands: meson setup build sudo ninja -C build install To uninstall, run sudo ninja -C build uninstall Installing to a Local Directory By default Meson installs to /usr/local. You can install without root permissions by choosing a local prefix, such as $PWD/run: meson setup build --prefix $PWD/run ninja -C build install You can then run it with GSETTINGS_SCHEMA_DIR=run/share/glib-2.0/schemas ./run/bin/foliate Flatpak Foliate is available on Flathub. For developement with Flatpak, use GNOME Builder to open and run the project. Snap Foliate is available on the Snap Store. To install: sudo snap install foliate Screenshots !Dark mode !Wikipedia lookup !Book metadata !Annotations !Popup footnote !Vertical writing License This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The following JavaScript libraries are bundled in this software: - foliate-js, which is MIT licensed. - zip.js, which is licensed under the BSD-3-Clause license. - fflate, which is MIT licensed. - PDF.js, which is licensed under Apache License 2.0. ---
Top issues
#115Windows build65 comments · 2019-07-09#139[Feature request] Add pdf and djvu support48 comments · 2019-07-15#401foliate could not open file23 comments · 2020-05-29#1142Don't use libadwaita22 comments · 2023-11-19#916Blurry fonts on HiDPI display19 comments · 2022-07-01#207Touchscreen text selection/highlighting18 comments · 2019-11-22#1102Snap: Failed to spawn child process “/usr/lib/x86_64-linux-gnu/webkitgtk-6.0/WebKitNetworkProcess”15 comments · 2023-11-02#1519Japanese brackets and punctuation14 comments · 2025-04-19
Discussions
#1745Project status and maintenance0 comments · 2026-11-07#1739How to dismiss CTRL + F search result highlighting1 comments · 2026-10-22#1720Why we lost the brightness and custom themes?1 comments · 2026-09-28#1713Feature Request: Custom book sections and sorting options0 comments · 2026-08-31#1700Add catalog for all users0 comments · 2026-08-08#1657Font size in Dictionary popup1 comments · 2026-04-05#1652Proposal: Adding a CONTRIBUTING.md file to streamline the contribution process0 comments · 2026-03-26#1651this would be alot better if you can mass select books0 comments · 2026-03-22
Latest release
3.3.0 3.3.0 2025-04-01- Updated for GNOME 48 - Added support for mouse forward/backward buttons (1474) - Improved text wrapping in headings - Improved default link style