mikespub / epubjs-reader
Epub.js Reader with zipfs.php
Suggests
- mikespub/seblucas-cops: COPS - Calibre OPDS (and HTML) PHP Server
README
此分支仅用于重新打包和集成 epubjs-reader 与 COPS
请参阅 https://github.com/intity/epubreader-js 以获取原始分支 - 并感谢 @intity 以及 alpha/beta 测试者 :-)
此分支旨在用于基于网络的 epub 阅读器,其中初始 bookPath
通过 dist/template.html 中的模板变量设置,例如使用 PHP Twig 或 Python Jinja2,epub 内容通过 PHP 或 Python 脚本如 src/zipfs.php 从原始 .epub 文件提供,例如 bookPath = http://localhost:8000/zipfs.php/{bookId}/
dist/ 文件 可用作为
- PHP composer 包: mikespub/epubjs-reader,或
- NPM JavaScript 包: @mikespub/epubjs-reader。
Epub.js Reader
关于阅读器
epubreader-js 应用程序基于 epub.js 库,是 epubjs-reader 仓库的分支。
入门
在浏览器中打开 epubreader-js。
您可以通过在 url 中传递指向 bookPath
的链接来更改它打开的 ePub
?bookPath=https://s3.amazonaws.com/epubjs/books/alice.epub
本地运行
安装 node.js
然后使用 npm 安装项目依赖项
npm install
您可以使用以下命令在本地运行阅读器
npm run serve
构建是通过 webpack 连接和压缩的
要生成新的构建运行
npm run build
或重新构建所有 *.js 文件
npm run prepare
预配置
epubreader-js 应用程序设置是一个您将其作为参数传递给 Reader
构造函数的 JavaScript 对象。您可以在 index.html 文件中进行初步设置。例如,这是默认 Reader
初始化的示例
<script type="module"> import { Reader } from "./js/epubreader.min.js" const url = new URL(window.location) const path = url.searchParams.get("bookPath") || "https://s3.amazonaws.com/moby-dick/" window.onload = (e) => new Reader(path) </script>
假设我们想禁用 openbook
功能,该功能旨在在个人计算机上打开 ePub 文件。这对于将公共图书馆集成到您的站点很有用。让我们这样做
<script type="module"> import { Reader } from "./js/epubreader.min.js" const url = "{{bookPath}}" window.onload = (e) => new Reader(url, { openbook: false }) </script>
请注意,使用
{{bookPath}}
替换令牌来定义url
字符串变量。这个简单的解决方案将允许您设置一个路由来传递目标 URL。
功能
epubreader-js 应用程序支持以下功能
- 对移动设备的初始支持
- 在浏览器本地存储中保存设置
- 从设备的文件系统打开书籍文件
- 书签
- 注释
- 通过书籍部分搜索
- 输出 ePub 元数据
- 键盘快捷键