{"id":13426178,"url":"https://github.com/johnfactotum/foliate","last_synced_at":"2025-05-12T15:32:59.620Z","repository":{"id":37388250,"uuid":"188673216","full_name":"johnfactotum/foliate","owner":"johnfactotum","description":"Read e-books in style","archived":false,"fork":false,"pushed_at":"2025-04-08T06:21:10.000Z","size":25488,"stargazers_count":7010,"open_issues_count":206,"forks_count":313,"subscribers_count":66,"default_branch":"gtk4","last_synced_at":"2025-04-22T20:11:59.177Z","etag":null,"topics":["azw","azw3","cbz","ebook-reader","epub","fb2","gjs","gtk","mobi","opds"],"latest_commit_sha":null,"homepage":"https://johnfactotum.github.io/foliate/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johnfactotum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"buy_me_a_coffee":"johnfactotum"}},"created_at":"2019-05-26T11:16:14.000Z","updated_at":"2025-04-22T14:53:25.000Z","dependencies_parsed_at":"2023-12-30T05:21:09.601Z","dependency_job_id":"2a1a7e0e-3be2-44a3-9251-cff2d52d4c07","html_url":"https://github.com/johnfactotum/foliate","commit_stats":{"total_commits":1656,"total_committers":92,"mean_commits":18.0,"dds":"0.16062801932367154","last_synced_commit":"afc4b033e76904f1d20604640b2727a58a2e8106"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfactotum%2Ffoliate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfactotum%2Ffoliate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfactotum%2Ffoliate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnfactotum%2Ffoliate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnfactotum","download_url":"https://codeload.github.com/johnfactotum/foliate/tar.gz/refs/heads/gtk4","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253765895,"owners_count":21960815,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azw","azw3","cbz","ebook-reader","epub","fb2","gjs","gtk","mobi","opds"],"created_at":"2024-07-31T00:01:28.225Z","updated_at":"2025-05-12T15:32:59.599Z","avatar_url":"https://github.com/johnfactotum.png","language":"JavaScript","readme":"\u003cimg src=\"data/com.github.johnfactotum.Foliate.svg\" align=\"left\" style=\"margin-right:8px\"\u003e \n\u003cbr\u003e\u003cbr\u003e\n\n# Foliate\n\nRead books in style.\n\n![Screenshot](data/screenshots/screenshot.png)\n\n## Installation\n\n### Run Time Dependencies\n\n- `gjs` (\u003e= 1.76)\n- `gtk4` (\u003e= 4.12)\n- `libadwaita` (\u003e= 1.7; `gir1.2-adw-1` in Debian-based distros)\n- `webkitgtk-6.0` (`webkitgtk6.0` in Fedora; `gir1.2-webkit-6.0` in Debian-based distros)\n\n#### Optional Dependencies\n\nTo 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).\n\nFor text-to-speech support, install `speech-dispatcher` and output modules such as `espeak-ng`.\n\nIf installed, `tracker` (\u003e= 3; `gir1.2-tracker-3.0` in Debian-based distros) and `tracker-miners` can be used to track the locations of files.\n\n### Obtaining the Source\n\nThe repo uses git submodules. Before running or installing, make sure you clone the whole thing with `--recurse-submodules`:\n\n```\ngit clone --recurse-submodules https://github.com/johnfactotum/foliate.git \n```\n\nOr download the tarball (the `.tar.xz` file) from the [Releases](https://github.com/johnfactotum/foliate/releases) page.\n\n### Run without Building or Installing\n\nIt's possible to run directly from the source tree without building or installing. Simply run\n\n```\ngjs -m src/main.js\n```\n\nThis can be useful if you just want to quickly try out Foliate or test a change.\n\nBut 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\n\n```\nglib-compile-schemas data\n```\n\nThen you can set the schema directory when running the app:\n\n```\nGSETTINGS_SCHEMA_DIR=data gjs -m src/main.js\n```\n\n### Building and Installing from Source\n\nThe following dependencies are required for building:\n\n- `meson` (\u003e= 0.59)\n- `pkg-config`\n- `gettext`\n\nTo install, run the following commands:\n\n```\nmeson setup build\nsudo ninja -C build install\n```\n\nTo uninstall, run\n\n```\nsudo ninja -C build uninstall\n```\n\n#### Installing to a Local Directory\n\nBy default Meson installs to `/usr/local`. You can install without root permissions by choosing a local prefix, such as `$PWD/run`:\n\n```\nmeson setup build --prefix $PWD/run\nninja -C build install\n```\n\nYou can then run it with\n\n```\nGSETTINGS_SCHEMA_DIR=run/share/glib-2.0/schemas ./run/bin/foliate\n```\n\n### Flatpak\n\nFoliate is available on [Flathub](https://flathub.org/apps/details/com.github.johnfactotum.Foliate).\n\nFor developement with Flatpak, use [GNOME Builder](https://wiki.gnome.org/Apps/Builder) to open and run the project.\n\n### Snap\n\nFoliate is available on the [Snap Store](https://snapcraft.io/foliate). To install:\n\n```\nsudo snap install foliate\n```\n\n## Screenshots\n\n![Dark mode](data/screenshots/dark.png)\n\n![Wikipedia lookup](data/screenshots/lookup.png)\n\n![Book metadata](data/screenshots/about.png)\n\n![Annotations](data/screenshots/annotations.png)\n\n![Popup footnote](data/screenshots/footnote.png)\n\n![Vertical writing](data/screenshots/vertical.png)\n\n## License\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n\nThe following JavaScript libraries are bundled in this software:\n\n- [foliate-js](https://github.com/johnfactotum/foliate-js), which is MIT licensed.\n- [zip.js](https://github.com/gildas-lormeau/zip.js), which is licensed under the BSD-3-Clause license.\n- [fflate](https://github.com/101arrowz/fflate), which is MIT licensed.\n- [PDF.js](https://github.com/mozilla/pdf.js), which is licensed under Apache License 2.0.\n\n---\n\n\u003ca href=\"https://www.buymeacoffee.com/johnfactotum\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" \u003e\u003c/a\u003e\n","funding_links":["https://buymeacoffee.com/johnfactotum","https://www.buymeacoffee.com/johnfactotum"],"categories":["JavaScript","HarmonyOS","E-books","Applications","By Language","工具","Table of Contents","应用","Office"],"sub_categories":["Windows Manager","E-books Readers","E-Book Utilities","JavaScript","效率工具","Reading","电子书工具","Book Readers"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnfactotum%2Ffoliate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnfactotum%2Ffoliate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnfactotum%2Ffoliate/lists"}