ReadFish for VS Code

VS Code 侧边栏版本,直接使用桌面版 ReadFish 的 Windows 用户数据目录:
%APPDATA%\ReadFish\,包括 bookshelf.json、book\、reading_history.json、bookmarks.json 和 config.json。
两端共享书架分组、TXT/EPUB 书籍和每本书的行级阅读进度。书架文件变更会自动刷新;阅读中的进度也会在两端间同步。
运行
在终端进入 vscode-extension,运行 npm install 安装 EPUB 阅读依赖。
在 VS Code 中打开 vscode-extension 文件夹并按 F5 启动扩展开发窗口;也可以用命令行启动:
code --extensionDevelopmentPath="<path-to-project>\ReadFish\vscode-extension" --new-window
点击 Activity Bar 上的 ReadFish 图标打开书架。
使用
- 点击书架标题栏的导入按钮,导入 TXT/EPUB 文件;插件将副本保存到桌面版共用的
book 目录。
- 书架分组支持新建、重命名、删除和嵌套;删除分组会把其中书籍移到“未分组”。
- “编辑模式”允许勾选多本书批量移动分组或移出书架。单击书籍会在 ReadFish 侧栏内切换到阅读页面,滚动位置自动写入桌面版的
reading_history.json。书架卡片的操作按钮在鼠标悬停时显示。
- “章节目录”按桌面版规则去重章节编号;每本书的“章节规则”按钮可设置默认、简单占位符或正则匹配规则。自定义规则写入桌面版共用的
config.json。
- 书架标题栏搜索支持按书名和正文查找;打开的书籍也可用 VS Code 的
Ctrl+F 查找当前正文。
- 在编辑器标题栏或按
Ctrl+Alt+B 添加书签。侧边栏“书签”目录可以跳转;右键或运行“ReadFish: 管理书签”可重命名、编辑备注和删除书签。数据使用桌面版 bookmarks.json 格式。
- 书架右上角齿轮可导出或恢复
.readfish 完整备份。备份只打包书架中登记的书籍,不包括 book 目录里已从书架移除的旧文件;恢复时可选择合并或替换书架。
- WebDAV 配置提供“上传到云端”和“从云端下载”两个单向操作。上传会把本机书架数据写入云端并按 SHA-256 去重书籍内容;下载会校验哈希后将云端书架合并到本机,不覆盖本机已有书籍,重名书会自动加序号。远端的
books/<SHA-256> 是内容寻址存储,文件名不直接显示书名;manifest.json 保存书名、原文件名、分组、进度和书签等映射,下载时会生成带哈希前缀的本机文件名。勾选“定时双向同步”后,扩展会在 VS Code 启动或保存配置后按设定间隔同步(默认关闭,最短 5 分钟)。桌面版和插件版共用 config.json 中的 WebDAV 地址、目录、账号和同步间隔;密码使用当前 Windows 用户的 DPAPI 加密保存。首次上传需要手动确认。
- “打开配置目录”直接打开
%APPDATA%\ReadFish。
WebDAV 服务端需支持标准 HTTP/WebDAV 的 MKCOL、GET、PUT 和条件写入请求。自动同步默认关闭,保存服务器地址后可先手动测试。使用账号密码时请填写 HTTPS 地址。
| |