{"id":13392943,"url":"https://github.com/koreader/koreader","last_synced_at":"2025-05-13T15:03:57.086Z","repository":{"id":7626824,"uuid":"8986217","full_name":"koreader/koreader","owner":"koreader","description":"An ebook reader application supporting PDF, DjVu, EPUB, FB2 and many more formats, running on Cervantes, Kindle, Kobo, PocketBook and Android devices","archived":false,"fork":false,"pushed_at":"2025-05-13T12:52:53.000Z","size":67938,"stargazers_count":21462,"open_issues_count":941,"forks_count":1439,"subscribers_count":328,"default_branch":"master","last_synced_at":"2025-05-13T13:29:47.122Z","etag":null,"topics":["cbz","djvu","djvu-reflow","ebook","ebook-reader","eink","epub","ereader","fb2","kindle","kobo","luajit","opds","pdf","pdf-reflow","pocketbook","reader","reflow","remarkable-tablet","ubuntu-touch"],"latest_commit_sha":null,"homepage":"http://koreader.rocks/","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koreader.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"liberapay":"KOReader"}},"created_at":"2013-03-24T13:09:42.000Z","updated_at":"2025-05-13T13:07:19.000Z","dependencies_parsed_at":"2023-11-29T00:25:14.036Z","dependency_job_id":"2e67eee4-f7d6-4eab-9658-e33591f94426","html_url":"https://github.com/koreader/koreader","commit_stats":{"total_commits":8272,"total_committers":249,"mean_commits":33.22088353413655,"dds":0.843568665377176,"last_synced_commit":"300634858529c1cd1bcd25f07feb6634ed7768b8"},"previous_names":[],"tags_count":264,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreader%2Fkoreader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreader%2Fkoreader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreader%2Fkoreader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreader%2Fkoreader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koreader","download_url":"https://codeload.github.com/koreader/koreader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253968483,"owners_count":21992255,"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":["cbz","djvu","djvu-reflow","ebook","ebook-reader","eink","epub","ereader","fb2","kindle","kobo","luajit","opds","pdf","pdf-reflow","pocketbook","reader","reflow","remarkable-tablet","ubuntu-touch"],"created_at":"2024-07-30T17:00:39.814Z","updated_at":"2025-05-13T15:03:52.045Z","avatar_url":"https://github.com/koreader.png","language":"Lua","readme":"[![KOReader](https://raw.githubusercontent.com/koreader/koreader.github.io/master/koreader-logo.png)](https://koreader.rocks)\n\n#### KOReader is a document viewer primarily aimed at e-ink readers.\n\n[![AGPL Licence][badge-license]](COPYING)\n[![Latest release][badge-release]][link-gh-releases]\n[![Gitter][badge-gitter]][link-gitter]\n[![Mobileread][badge-mobileread]][link-forum]\n[![Build Status][badge-circleci]][link-circleci]\n[![Coverage Status][badge-coverage]][link-coverage]\n[![Weblate Status][badge-weblate]][link-weblate]\n\n[Download](https://github.com/koreader/koreader/releases) •\n[User guide](http://koreader.rocks/user_guide/) •\n[Wiki](https://github.com/koreader/koreader/wiki) •\n[Developer docs](http://koreader.rocks/doc/)\n\n## Main features\n\n* **portable**: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook, reMarkable), Android and Linux computers. Developers can run a KOReader emulator in Linux and MacOS.\n\n* **multi-format documents**: supports fixed page formats (PDF, DjVu, CBT, CBZ) and reflowable e-book formats (EPUB, FB2, Mobi, DOC, RTF, HTML, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library. [ZIP files][link-wiki-zip] are also supported for some formats.\n\n* **full-featured reading**: multi-lingual user interface with a highly customizable reader view and many typesetting options. You can set arbitrary page margins, override line spacing and choose external fonts and styles. It has multi-lingual hyphenation dictionaries bundled into the application.\n\n* **integrated** with *calibre* (search metadata, receive ebooks wirelessly, browse library via OPDS), *Wallabag*, *Wikipedia*, *Google Translate* and other content providers.\n\n* **optimized for e-ink devices**: custom UI without animation, with paginated menus, adjustable text contrast, and easy zoom to fit content or page in paged media.\n\n* **extensible**: via plugins\n\n* **fast**: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.\n\n* **and much more**: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, over-the-air software updates, an FTP client, an SSH server, …\n\nPlease check the [user guide](http://koreader.rocks/user_guide/) and the [wiki][link-wiki] to discover more features and to help us document them.\n\n## Screenshots\n\n\u003ca href=\"https://github.com/koreader/koreader-artwork/raw/master/koreader-menu.png\"\u003e\u003cimg src=\"https://github.com/koreader/koreader-artwork/raw/master/koreader-menu-thumbnail.png\" alt=\"\" width=\"200px\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/koreader/koreader-artwork/raw/master/koreader-footnotes.png\"\u003e\u003cimg src=\"https://github.com/koreader/koreader-artwork/raw/master/koreader-footnotes-thumbnail.png\" alt=\"\" width=\"200px\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/koreader/koreader-artwork/raw/master/koreader-dictionary.png\"\u003e\u003cimg src=\"https://github.com/koreader/koreader-artwork/raw/master/koreader-dictionary-thumbnail.png\" alt=\"\" width=\"200px\"\u003e\u003c/a\u003e\n\n## Installation\n\nPlease follow the model specific steps for your device:\n\n[Android](https://github.com/koreader/koreader/wiki/Installation-on-Android-devices) •\n[Cervantes](https://github.com/koreader/koreader/wiki/Installation-on-BQ-devices) •\n[Kindle](https://github.com/koreader/koreader/wiki/Installation-on-Kindle-devices) •\n[Kobo](https://github.com/koreader/koreader/wiki/Installation-on-Kobo-devices) •\n[Linux](https://github.com/koreader/koreader/wiki/Installation-on-desktop-linux) •\n[Pocketbook](https://github.com/koreader/koreader/wiki/Installation-on-PocketBook-devices) •\n[reMarkable](https://github.com/koreader/koreader/wiki/Installation-on-Remarkable)\n\n\n## Development\n\n[Setting up a build environment](doc/Building.md) •\n[Collaborating with Git](doc/Collaborating_with_Git.md) •\n[Building targets](doc/Building_targets.md) •\n[Porting](doc/Porting.md) •\n[Developer docs](http://koreader.rocks/doc/)\n\n## Support\n\nKOReader is developed and supported by volunteers all around the world. There are many ways you can help:\n\n- [fix bugs][link-issues-bugs] and [implement new features][link-issues-features]\n- [translate the program into your language][link-weblate] or improve an existing translation\n- document lesser-known features on the [wiki][link-wiki]\n- help others with your knowledge on the [forum][link-forum]\n\nRight now we only support [liberapay](https://liberapay.com/KOReader) donations.\n\n## Contributors\n\n[![Last commit][badge-last-commit]][link-gh-commits]\n[![Commit activity][badge-commit-activity]][link-gh-insights]\n\n[badge-bountysource]:https://img.shields.io/bountysource/team/koreader/activity?color=red\n[badge-circleci]:https://circleci.com/gh/koreader/koreader.svg?style=shield\n[badge-coverage]:https://codecov.io/gh/koreader/koreader/branch/master/graph/badge.svg\n[badge-commit-activity]:https://img.shields.io/github/commit-activity/m/koreader/koreader\n[badge-gitter]:https://img.shields.io/gitter/room/koreader/koreader?color=red\n[badge-last-commit]:https://img.shields.io/github/last-commit/koreader/koreader?color=orange\n[badge-license]:https://img.shields.io/github/license/koreader/koreader\n[badge-release]:https://img.shields.io/github/release/koreader/koreader.svg\n[badge-mobileread]:https://img.shields.io/badge/forum-on_mobileread-lightgrey\n[badge-weblate]:https://hosted.weblate.org/widgets/koreader/-/koreader/svg-badge.svg\n\n[link-bountysource]:https://www.bountysource.com/teams/koreader\n[link-circleci]:https://circleci.com/gh/koreader/koreader\n[link-coverage]:https://codecov.io/gh/koreader/koreader\n[link-forum]:http://www.mobileread.com/forums/forumdisplay.php?f=276\n[link-gh-commits]:https://github.com/koreader/koreader/commits/master\n[link-gh-insights]:https://github.com/koreader/koreader/pulse\n[link-gh-releases]:https://github.com/koreader/koreader/releases\n[link-gitter]:https://gitter.im/koreader/koreader\n[link-issues-bugs]:https://github.com/koreader/koreader/issues?q=is%3Aopen+is%3Aissue+label%3Abug\n[link-issues-features]:https://github.com/koreader/koreader/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement\n[link-weblate]:https://hosted.weblate.org/engage/koreader/?utm_source=widget\n[link-wiki]:https://github.com/koreader/koreader/wiki\n[link-wiki-zip]:https://github.com/koreader/koreader/wiki/ZIP\n","funding_links":["https://liberapay.com/KOReader"],"categories":["Alternate Reading Apps","Lua","阅读器","LUA","Software","工具","其他","资源","Table of Contents","jQuery","others","Resources","Applications","Language Learning","Viewers"],"sub_categories":["效率工具","网络服务_其他","Scriptable by Lua","Reading","RESTful","Other APIs","Reader Programs or extensions"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoreader%2Fkoreader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoreader%2Fkoreader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoreader%2Fkoreader/lists"}