Weread Vault

Weread Vault

Weread Vault（微信读书知识库）是一款 Obsidian 插件，用于把微信读书、纸质书单和个人读书笔记整理到同一个可长期维护的知识库中。

它基于 zhaohongxuan/obsidian-weread-plugin 二次开发，保留原项目的微信读书同步能力，并增加书单导入、独立个人笔记和外部文件导入等功能。来源与修改说明见 NOTICE.md。

Weread Vault 是社区项目，与腾讯、微信读书和 Obsidian 官方无隶属或授权关系。

兼容性

• Obsidian 1.8.7 或更高版本。
• 仅支持桌面端（macOS、Windows 和 Linux）。
• 插件使用 Electron 窗口完成微信读书扫码登录，因此不声明移动端兼容。

核心能力

• 同步微信读书的书籍元数据、高亮、想法、书评和热门划线。
• 粘贴书单，搜索并选择对应的微信读书版本，批量加入 Obsidian。
• 没有电子划线也可以建立纸质书条目。
• 从书架顶部或单本书卡片创建关联读书笔记。
• 在一个可搜索下拉框中按书名、作者或 bookId 选择书籍。
• 导入 Markdown、TXT 和 DOCX 笔记。
• Word 中的段落、表格和图片可保留；图片型 Word 会建立可继续整理的区域。
• 个人笔记独立保存，不会被微信读书的覆盖式同步删除。
• 书籍详情页同时展示微信读书想法和本地个人笔记。
• 书架和阅读统计页面可以打开全部笔记清单。
• 支持 3:4 等视频工作流所需的 Obsidian 书籍封面与笔记读取。

为什么个人笔记要独立保存

微信读书同步文件属于可重复生成的数据。再次同步时，插件可能重建这些文件。

Weread Vault 将个人笔记保存为独立 Markdown 文件，并通过以下字段关联原书：

doc_type: weread-reading-note
bookId: "书籍 ID"
bookTitle: 书名
bookAuthor: 作者
sourceNote: 原书笔记路径

因此你可以安全记录感想、问题、行动清单和视频选题，而不必担心同步覆盖。

安装

从 Obsidian 社区插件市场安装

审核发布后，可在“设置 → 第三方插件 → 浏览”中搜索 Weread Vault 并安装。

发布审核前从 GitHub Release 安装

1. 在 Releases 下载 weread-vault-版本号.zip。
2. 解压到 Vault 的 .obsidian/plugins/weread-vault/。
3. 确认目录中包含：
   • main.js
   • manifest.json
   • styles.css
4. 在 Obsidian 的“设置 → 第三方插件”中启用 Weread Vault。

正式进入 Obsidian 社区插件市场前，可使用 GitHub Release 或 BRAT 安装测试版。

从源码构建

需要 Node.js 22 或更高版本。

git clone https://github.com/zhengxn1/weread-vault.git
cd weread-vault
npm ci
npm run build

构建产物位于 dist/。

从原 Weread 插件迁移

Weread Vault 使用新的插件 ID：weread-vault，不会覆盖原插件目录。

迁移时建议：

1. 先备份 Vault。
2. 记录原插件的笔记保存目录和模板设置。
3. 禁用原 Weread 插件。
4. 安装并启用 Weread Vault。
5. 重新填写 API Key 或扫码登录。
6. 确认原有微信读书笔记目录后再同步。

不要同时启用原插件和 Weread Vault，两者会使用相近的命令和视图入口。

使用书单批量导入

1. 打开微信读书书架。
2. 点击顶部“从书单批量导入”。
3. 每行填写一本书，可包含编号和书名号。
4. 点击匹配，检查候选版本。
5. 取消不确定的项目，确认后导入。

已有 bookId 的书不会重复创建。低置信度匹配不会默认选中。

创建或导入个人笔记

1. 在书架顶部点击“记笔记”，或者点击单本书卡片上的笔记按钮。
2. 在下拉框内搜索书名、作者或 bookId。
3. 选择笔记类型并填写内容。
4. 如有外部资料，可导入 .md、.txt 或 .docx。
5. 保存后，笔记位于“微信读书笔记目录/读书笔记/书名”。

保存后的个人笔记可以从以下位置打开：

• 单本书详情页的“笔记”标签。
• 书架顶部的笔记统计。
• 阅读统计页面的笔记卡片。

网络、账号与隐私披露

使用微信读书同步功能需要用户自己的微信读书账号。插件支持扫码登录、CookieCloud 或微信读书 API key；这些凭据只保存在当前 Vault 的本地插件配置中。

插件可能访问以下网络位置：

• weread.qq.com：登录、书架、书籍、高亮、想法和阅读数据。
• i.weread.qq.com：微信读书 Agent API 和书籍搜索。
• cdn.weread.qq.com：微信读书封面资源。
• 用户自行配置的 CookieCloud 服务地址：读取加密 Cookie 数据。
• 用户主动填写的主题文件 URL：仅在执行“从 URL 导入主题”时访问。

插件处理的数据包括书籍元数据、高亮、想法、书评、热门划线，以及用户主动导入的 Markdown、TXT、DOCX 和其中的图片。导入内容只写入当前 Vault；插件不会上传个人笔记。

• 不包含遥测、行为分析、广告或付费功能。

• 不会出售、共享或用于训练用户数据。

• 不会分发书籍正文。

• Cookie、API key、用户 ID 和个人笔记不会写入项目仓库。

• 卸载插件前如需彻底移除凭据，可先在设置中注销并清除 API key，然后删除插件目录中的 data.json。

• API Key、Cookie 和 Obsidian 路径只应保存在本机插件配置中。

• 不要把 .obsidian/plugins/weread-vault/data.json 提交到 GitHub。

• 不要把真实 API Key 写进测试脚本、Issue、截图或日志。

• npm run test:api 只从环境变量 WEREAD_API_KEY 读取测试 Key。

• 书籍、划线、个人笔记、导入文件和生成图片属于用户数据，不应进入代码仓库。

开发与验证

npm ci
npm run build

可选的真实 API 冒烟测试：

WEREAD_API_KEY="你的临时测试 Key" npm run test:api

不要在共享终端记录或 CI 配置中长期保存真实 Key。

发布

推送与 manifest.json 版本一致的 Git 标签后，GitHub Actions 会构建并发布：

• weread-vault-版本号.zip
• main.js
• manifest.json
• styles.css

发布前请执行 发布检查清单。

首次进入 Obsidian 社区目录，需要先在 GitHub 发布 1.0.0 Release，然后前往 Obsidian Community 提交仓库地址。

许可证与来源

项目采用 MIT License。

MIT 许可证允许使用、修改和重新发布，但必须在副本或主要部分中保留原版权声明与许可证。Weread Vault 因此保留原 LICENSE，并在 NOTICE.md 中说明上游项目和主要修改。

免责声明

本项目只处理登录用户有权访问的书架、笔记和用户主动导入的内容，不提供或分发书籍正文。使用者应遵守微信读书、Obsidian 以及所在地区适用的服务条款和法律。