Obsidian Weread 插件使用教程

项目介绍

Obsidian Weread 插件是一个为 Obsidian 笔记应用设计的社区插件，用于同步微信读书中的书籍元信息、高亮标注、划线感想、书评等内容，并将这些信息转换为 markdown 格式保存到 Obsidian 的文件夹中。

核心功能特性

• 书籍元数据同步：自动同步书籍封面、作者、出版社、ISBN、出版时间等完整信息
• 完整笔记支持：支持同步划线笔记、页面笔记、章节笔记、书籍书评等多种笔记类型
• 微信扫码登录：支持微信扫码登录，与浏览器保持一致的长时间登录状态
• 智能同步机制：首次同步较慢，后续只更新有变化的书籍，速度很快
• 模板自定义：支持自定义笔记生成模板，满足个性化需求
• 移动端适配：完美支持手机和平板设备同步
• Daily Notes 集成：可将当日读书笔记同步至 Daily Notes 中

快速安装配置

第一步：插件安装

在 Obsidian 社区插件市场中搜索"weread"，找到"Weread Plugin"点击安装，安装完成后点击启用插件。

第二步：账户登录配置

1. 打开 Obsidian 设置，进入"Obsidian Weread Plugin"设置页面
2. 点击右侧"登录"按钮，在弹出的登录页面扫码登录
3. 登录完成后会显示个人昵称，表示登录成功

第三步：同步设置

配置笔记保存位置、笔记最小划线数量、笔记文件夹分类等参数，根据个人需求进行个性化设置。

基础使用方法

1. 点击左侧 Ribbon 上的微信读书按钮
2. 或使用 Command+P(Windows Ctrl+P)调出命令面板，输入"Weread"找到"Sync Weread command"执行同步
3. 同步完成后，笔记将保存到指定文件夹中

高级功能配置

自定义模板设置

插件提供丰富的模板自定义功能，默认模板位于 src/assets/wereadOfficialTemplate.njk，用户可以根据需要修改模板格式。

Daily Notes 集成

在设置中打开同步到 Daily Notes 的开关，设置 Daily Notes 的目录以及文件格式，支持 Periodic Notes 格式管理。

文件名和文件夹配置

支持多种文件名格式设置（BOOK_NAME、BOOK_ID等），支持按书籍类型、作者等多种方式进行文件夹分类。

技术实现细节

插件通过微信读书官方 API 接口获取数据，核心 API 调用逻辑位于 src/api.ts，支持获取书籍详情、划线笔记、书评信息等多种数据。

同步逻辑实现位于 src/syncNotebooks.ts，采用智能同步机制，只更新有变化的书籍内容。

最佳实践建议

学术研究笔记管理

研究人员可以使用该插件将专业书籍的阅读笔记自动整理到 Obsidian 中，建立 interconnected 知识网络，便于论文写作时快速查找和引用相关资料。

团队知识共享

团队成员通过同步阅读笔记到共享知识库，实现知识的共享和协作，促进团队学习效率。

个人知识体系构建

结合 Obsidian 的双向链接功能，将读书笔记与个人知识体系深度融合，形成完整的知识图谱。

注意事项

• 本插件是覆盖式更新，请不要在同步的文件里直接修改内容
• 写永久笔记时建议使用 Block 引用的方式在外部进行批注
• 长期不使用插件时 Cookie 可能会失效，需要重新登录
• 偶尔可能会有网络连接问题，重新点击同步即可

技术支持与资源

• 官方 API 文档参考：docs/weread-api.md
• 设置配置管理：src/settings.ts
• 社区支持：Obsidian 官方论坛获取最新更新和技巧分享

通过本指南，您将能够充分利用 Obsidian Weread 插件，实现微信读书笔记的高效管理和知识整合，提升个人知识管理效率。