Reader 📖
在 VS Code 中阅读电子书的简洁阅读器

✨ 功能特性
- 📄 多格式支持:PDF、EPUB、TXT、Markdown
- 📜 连续滚动:类 Kindle 阅读体验
- 🎨 主题切换:浅色 / 深色 / 护眼(偏黄)
- 🔍 缩放控制:50% ~ 400%
- 💾 进度记忆:自动保存并恢复阅读位置
- 📑 目录导航:支持 EPUB/PDF 目录跳转
- ⌨️ 键盘翻页:左右箭头、Page Up/Down、Space
- 🔊 听书模式:支持 TXT / Markdown / EPUB / PDF(文本型)朗读
📦 支持格式
| 格式 |
状态 |
渲染引擎 |
| PDF |
✅ |
pdf.js |
| EPUB |
✅ |
epub.js |
| TXT |
✅ |
原生渲染 |
| Markdown |
✅ |
简易解析 |
🚀 安装
从 VSIX 安装
- 下载
.vsix 文件
- VS Code 中按
Cmd/Ctrl+Shift+P
- 运行
Extensions: Install from VSIX...
- 选择下载的文件
从源码安装
cd reader
npm install
npm run compile
📖 使用方法
- 按
Cmd+Shift+P (macOS) 或 Ctrl+Shift+P (Windows/Linux)
- 输入
Reader: Open Book
- 选择要阅读的文件
快捷键:Cmd+Alt+R (macOS) 或 Ctrl+Alt+R (Windows/Linux)
⌨️ 键盘快捷键
| 按键 |
功能 |
← / PageUp |
上一页 |
→ / PageDown / Space |
下一页 |
Home |
跳到开头 |
End |
跳到结尾 |
Esc |
关闭目录 |
Ctrl/Cmd + Shift + L |
听书播放 / 暂停 |
Ctrl/Cmd + Shift + K |
停止听书 |
🖱️ 鼠标操作
- 点击页面 左侧 30% 区域:上翻
- 点击页面 右侧 30% 区域:下翻
🔊 听书说明
- 听书引擎使用浏览器内置
Web Speech API,无需额外服务
- 支持选择语音、语速、自动滚动,且会记忆配置
- PDF 仅支持“文本型 PDF”提取朗读
- 扫描版 PDF(图片无文本层)无法直接朗读,当前版本不含 OCR
🔧 开发
# 安装依赖
npm install
# 编译
npm run compile
# 监听模式
npm run watch
# 打包
npm run package
🚀 GitHub Actions 发布
仓库已内置发布工作流:.github/workflows/publish.yml
- 触发方式 1:推送标签(
v*),例如 v1.0.3
- 触发方式 2:GitHub Actions 页面手动运行
Publish VS Code Extension
- 发布目标:Visual Studio Marketplace(
vsce publish)
1) 配置密钥
在 GitHub 仓库设置中添加:
Settings -> Secrets and variables -> Actions -> New repository secret
- Secret 名称:
VSCE_PAT
- Secret 值:你的 Marketplace 发布 PAT
2) 发布步骤(推荐)
- 更新
package.json 里的 version
- 提交并推送到
main
- 打标签并推送:
git tag v1.0.3
git push origin v1.0.3
3) 注意事项
- Marketplace 不允许重复版本号发布
tag 建议与 package.json 版本一致(例如都为 1.0.3)
- 如果工作流报
VSCE_PAT secret is missing,先检查 Secret 是否已配置
📄 许可证
MIT
| |