{"id":15641288,"url":"https://github.com/azu/mu-epub-reader","last_synced_at":"2025-04-19T12:06:41.397Z","repository":{"id":66143517,"uuid":"208366697","full_name":"azu/mu-epub-reader","owner":"azu","description":"Epub viewer on Electron that support text translation.","archived":false,"fork":false,"pushed_at":"2023-10-09T07:17:33.000Z","size":4519,"stargazers_count":78,"open_issues_count":3,"forks_count":8,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-12T18:01:53.738Z","etag":null,"topics":["app","electron","epub","software","translation","viewer"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/azu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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},"funding":{"github":"azu"}},"created_at":"2019-09-14T00:20:10.000Z","updated_at":"2024-11-20T00:58:43.000Z","dependencies_parsed_at":"2024-10-03T11:42:17.123Z","dependency_job_id":"f9962ff5-caa9-406b-aaf4-4016486d4782","html_url":"https://github.com/azu/mu-epub-reader","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fmu-epub-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fmu-epub-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fmu-epub-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azu%2Fmu-epub-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/azu","download_url":"https://codeload.github.com/azu/mu-epub-reader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246156025,"owners_count":20732357,"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":["app","electron","epub","software","translation","viewer"],"created_at":"2024-10-03T11:42:06.130Z","updated_at":"2025-03-30T21:31:50.063Z","avatar_url":"https://github.com/azu.png","language":"JavaScript","funding_links":["https://github.com/sponsors/azu"],"categories":[],"sub_categories":[],"readme":"# mu-epub-reader\n\nEpub viewer on Electron.\n\nThis application is forked of [futurepress/epubjs-reader: Epub.js Reader](https://github.com/futurepress/epubjs-reader).\n\n## Features\n\n- Standalone Electron app\n- Integrate with Google Translation\n- Shortcuts: \n    - \u003ckbd\u003e←\u003c/kbd\u003e: Prev Page\n    - \u003ckbd\u003e→\u003c/kbd\u003e: Next Page\n    - \u003ckbd\u003ej\u003c/kbd\u003e or \u003ckbd\u003eSpace\u003c/kbd\u003e: Scroll down\n    - \u003ckbd\u003ek\u003c/kbd\u003e or \u003ckbd\u003eShift+Space\u003c/kbd\u003e: Scroll up\n    - \u003ckbd\u003eCmd+o\u003c/kbd\u003e: Open file\n    - \u003ckbd\u003eCmd+^\u003c/kbd\u003e: Increase font size\n    - \u003ckbd\u003eCmd+-\u003c/kbd\u003e: Decrease font size\n    - \u003ckbd\u003eCmd+0\u003c/kbd\u003e: Reset font size\n- One column mode: continuous scroll like PDF\n- Open file with arguments\n\n![en](./docs/img/en.png)\n![ja](./docs/img/ja.png)\n\n\u003e Quote from \u003chttps://book.systemsapproach.org/\u003e\n\n## Usage\n\n1. Click *File* \u003e *Open File* \n2. Select epub file\n3. View epub\n\n![menu](./docs/img/menu.png)\n\nor\n\n1. Open epub file with mu-epub-reader\n2. View epub\n\n## Installation\n\n**Electron Version**:\n\nDownload app and Install it.\n\n- [Download binary from Latest Release](https://github.com/azu/mu-epub-reader/releases/latest)\n\n:warning: This app is not signed. So, it will appear warning about un-signed app.\n\n**Web Version**:\n\n- \u003chttps://mu-epub-reader.netlify.app/?bookPath=https://mu-epub-reader.netlify.app/example/childrens-literature.epub\u003e\n    - :warning: Require CORS setting for each epub files\n    - :memo: Source: https://github.com/IDPF/epub3-samples/tree/master/30/childrens-literature/EPUB\n\n## Development\n\nBuild electron app\n\n    yarn install\n    yarn run dist\n    # output .app to dist/\n\nLoad `reader/override.js` or [`\u003cAppData\u003e/mu-epub-viewer/override.js`](https://electronjs.org/docs/all#appgetpathname) if exists.\n\n```\n- macOS: ~/Library/Application Support/mu-epub-viewer/override.js\n```\n\n1. Put custom logic script to `reader/override.js`\n2. Restart app\n3. mu-epub-reader preload `reader/override.js` in renderer process.\n\n`override.js` example: modify request url\n\n```js\nconst origOpen = XMLHttpRequest.prototype.open;\nXMLHttpRequest.prototype.open = function (...args) {\n    const originalURL = args[1];\n    const url = new URL(originalURL);\n    /// hack something...\n    args[1] = url.toString();\n    origOpen.apply(this, args);\n};\n```\n\n## Release\n\n    npm version patch\n    git push --tags \u0026\u0026 git push\n\n\n## Related\n\n- [azu/mu-pdf-viewer: PDF viewer on electron.](https://github.com/azu/mu-pdf-viewer)\n    - PDF Viewer\n- [Epub.js](https://github.com/futurepress/epub.js/) library\n\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazu%2Fmu-epub-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazu%2Fmu-epub-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazu%2Fmu-epub-reader/lists"}