Obsidian Weread Plugin 技术文档

安装指南

安装方法

1. 打开Obsidian，进入插件市场。
2. 在搜索栏中输入weread，找到Weread Plugin。
3. 点击install进行安装。
4. 安装完成后，点击Enable启用插件。

设置

1. 打开Obsidian，点击设置进入设置界面。
2. 找到Obsidian Weread Plugin，进入插件设置页面。
3. 点击右侧登录按钮，使用微信扫码登录。
4. 登录成功后，设置笔记保存位置、笔记最小划线数量、笔记文件夹分类等。

项目的使用说明

基础使用

1. 点击左侧Ribbon上的微信读书按钮，或使用快捷键command+P（Windows为ctrl+P）调出Command Palette。
2. 输入Weread，找到Sync Weread command进行同步。

同步笔记到Daily Notes

1. 在设置中打开同步到Daily Notes的开关。
2. 设置Daily Notes的目录及文件格式。
3. 设置在Daily Notes的特定区间插入笔记内容。

项目API使用文档

Weread API

• 本插件使用Weread API进行数据同步。
• API文档详见Weread API。

已知问题

• 长期不使用本插件Cookie可能会失效，需重新登录。
• 偶尔可能会有网络连接问题，重新点击同步即可。

TODO

• 解决Obsidian中CORS问题
• 设置界面笔记保存路径
• 优化文件同步逻辑
• 被动刷新Cookie延长有效期
• 多处登录导致Cookie失效Fix
• 弹出扫码框登录自动获取Cookie
• 书名重复导致同步失败
• 设置页面支持设置Template格式
• 文件名模板
• 移动端适配
• 按照章节Index进行排序
• 保留多个章节层级
• 导出热门划线
• 设置页面，目录选择优化

免责声明

本程序没有爬取任何书籍内容，只提供登录用户的图书以及笔记信息，没有侵犯书籍作者版权和微信读书官方利益。

感谢

• wereader
• Kindle Plugin
• Hypothesis Plugin
• Obsidian Plugin Developer Docs
• http proxy middleware
• nunjucks