document is edited with google doc, it is recommended to read the original document:
https://docs.google.com/document/d/1X-FXNhC4CyYq0W51ok1uEHcL0JQ8f9RhBHXyC2Le6yA/edit?usp=sharing
sreadium is web Epub reader based on the Readium-js-viewer project
mainly adds bookmark function and pwa offline use support, and
modified some ui to be more suitable for mobile phone use.
Readium-js-viewer is the official project of the epub standard developer, a web epub reading tool
recommended to use the chrome browser to open
Drag the Epub file to the browser window to start reading, and
menu bar on the smartphone file button to open
in the project folder and starting the http server
of being based on readium, with good compatibility.
Web application, convenient and fast.
Native app experience:
After opening sreadium for the first time, it will be automatically cached locally, and then it can be used offline (yes, sreadium can), At the same time, the loading speed is improved
. The mobile browser will have an installation option, it can be started in the launcher.
does not support uploading books.
At present, sreadium, like readium, is a pure front-end project, so you cannot add local books to the library.
You can deploy an opds library separately by imitating /epub_content, and then let readium open it through the url, the format is similar tohttps://sreadium. vercel.app/?epubs=https://your_libraray.opds .
highlighted part should be replaced accordingly
annotation is not supported.
At present, you can consider usinghttp://hypothes.is/and install the plug-in provided by it, which can realize the function of highlighting and annotating all web content. The
follow-up may provide access to a similar Google network Disk to open Epub and save annotations
https://github.com/readium/readium-js-viewer
The readium-js-viewer project provides a basic web reader, the
main functions are:
book library(can not add local files to book library, read Local files can only be dragged to the window using drag-drop)
reading and annotation(the annotation function is defective)
table
sharing the current reading page
full screen mode
Official Surge deployment
adds some important functions on the basis of readium-js-viewer, optimizes some ui and is more suitable for mobile phones.
bookmarks (unbelievable that readium-js-viewer does not provide bookmark function),
offline use function (through serviceworker and Caches)
PWA support similar to native app experience(offline use, can be installed, and then opened through mobile phone launcher, supported by service work and Caches)
Other modifications to
table of contents support folding
home page library menu bar Hide add local book button (because it is useless)
top menu The bar will not disappear when it is moved to the bottom (convenient for mobile phones)
, and a button to open local files is added (convenient for mobile phones, and the computer can use drag and drop directly)
sreadium is an abnormal web development,
but a hack modification, which
is to modify the style and html after readium renders the epub content, add some js, and put the main file in /sreadiumhack/
sreadium rarely modify the readium code directly
Readium source code directly Use its released minify js bundle
(https://github.com/readium/readium-js-viewer/releases/download/v0.32.0/Readium_cloud-reader.zip)
使用说明 / readme
文档 使用 google doc 编辑,建议阅读原文档:
https://docs.google.com/document/d/1X-FXNhC4CyYq0W51ok1uEHcL0JQ8f9RhBHXyC2Le6yA/edit?usp=sharing
sreadium 是基于 Readium-js-viewer 项目魔改的 web Epub 阅读器，
主要增加 书签功能 和 pwa 离线使用支持,
修改了部分 ui 更适合手机 使用。
Readium-js-viewer 是epub标准制定方官方项目,一个 web epub 阅读工具
推荐使用 chrome 浏览器打开
拖拽 Epub 文件到浏览器窗口开始阅读，
智能手机点击菜单栏 文件按钮 打开
在项目文件夹启动 http server
基于 readium，兼容性好.
web 应用，方便快速.
原生app体验:
第一次打开 sreadium 后会自动缓存到本地，之后可 离线使用 （是的，sreadium 能），同时加载速度提升
手机浏览器打开 sreadium 后会有 安装选项，安装后可在launcher 启动
不支持上传书籍
目前 sreadium 和 readium 一样,是一个 纯前端项目，所以不能添加本地图书到书库，
可以仿照 /epub_content 单独部署一个opds书库,然后让 readium 通过 url 打开,格式类似https://sreadium.vercel.app/?epubs=https://your_libraray.opds .
高亮部分要相应替换
不支持批注
目前批注可以考虑使用http://hypothes.is/,安装其提供的插件,可以实现对所有 web 内容高 亮和批注笔记功能
后续可能会提供接入类似谷歌网盘打开 Epub 和保存批注
https://github.com/readium/readium-js-viewer
readium-js-viewer 项目提供了一个基本的 web 阅读器,
主要功能有：
书库（不能添加本地文件到书库，阅读本地文件只能使用 drag-drop 拖拽文件到窗口）
阅读和批注（批注功能有缺陷）
目录表
分享当前阅读页面
全屏模式
官方 Surge deployment
在 readium-js-viewer 基础上增加了一些重要功能，优化了一些ui更适合手机使用
书签 （难以置信readium-js-viewer 不提供书签功能），
离线使用功能 （通过 serviceworker 和 Caches）
类似原生 app 体验的 pwa 支持（离线使用，可安装,之后通过手机 launcher 打开，由 service work 和 Caches 提供支持）
其它修改
目录表 支持折叠
首页书库菜单栏隐藏添加本地书籍按钮（因为没用）
顶部菜单栏移动到底部不会消失（方便手机使用）
增加打开本地文件按钮（方便手机使用，电脑可直接使用拖拽）
sreadium 是非正常web 开发,
而是一种 hack 修改,
是在readium渲染好 epub 内容后修改 style 和 html ,添加一些js,主要文件放在 /sreadiumhack/
sreadium 很少对 readium代码直接修改
Readium 源码直接使用其发布的 minify js bundle
(https://github.com/readium/readium-js-viewer/releases/download/v0.32.0/Readium_cloud-reader.zip)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent