Weave EPUB Reader

简体中文 | 繁體中文 | English | Español | Français | 日本語 | 한국어 | Русский | العربية

English Documentation

Introduction

Weave Epub Reader is a reader plugin in the Obsidian Weave plugin series, built fully for Obsidian and available across Obsidian platforms. It freely supports reading EPUB, TXT, FB2/FBZ, MOBI, AZW3, CBZ, PDF, and more, plus multi-style excerpt notes. Excerpts can be stored in Markdown, Canvas, and Weave deck files, with source links for jumping between notes and the book, and data stays fully local.

The essential experience covers daily reading, bookshelf management, excerpt summaries, book data page templates, and in-body rendering. Premium support adds library-wide excerpt timelines, two-way tracing, paragraph reading / immersive fullscreen, vocabulary marking and study, and more—using tools inside Obsidian to think, sharpen judgment, and make reading count.

Tip: Questions welcome—email [email protected]

Minimum Obsidian version: 1.8.7

Essential experience and Premium support

Legend: ✅ included · 🔒 requires Premium support

• Enable Premium support: Use an EPUB-only activation code in reader settings; if an activated Weave main plugin is installed, authorization can be inherited without re-entering a code.
• Card making / incremental reading / AI: Do not consume a separate reader Premium-support license, but require Weave; AI also needs your own API key.

Activate in reader settings. Terms: PREMIUM_TERMS.md.

Installation

Option 1: Community plugins (recommended)

1. Open Settings → Community plugins → Browse
2. Search for Weave EPUB Reader, install, and enable

Option 2: Manual installation

1. Download a GitHub release matching the version in manifest.json:
   • main.js
   • manifest.json
   • styles.css
2. Copy into .obsidian/plugins/weave-epub-reader/
3. Restart Obsidian and enable Weave EPUB Reader under Settings → Community plugins

Quick start

1. After enabling the plugin, open the bookshelf from the ribbon or command palette, then import or open a book from your vault.
2. Create or open a Markdown file and place the cursor where excerpts should go; turn on Auto excerpt in the reader. Select text to create highlights, excerpts, or bookmarks—they are inserted at that cursor.
3. Click a highlight in the book to jump to its source note from the toolbar; in the Markdown / Canvas that holds the excerpt, click the book icon next to it to return to the matching passage.
4. Reader menu → Help → Tutorial for the in-app short guide; FAQ item 1 covers the excerpt workflow in more detail.

Data and sync

Good to sync (in the vault): Book files, Markdown excerpts, Canvas files, Weave deck data, and per-book progress/bookmark notes (default Weave EPUB Reader/data_*.md).

Usually local (plugin folder): Reader cache, indexes, Canvas bindings, reference reading points, and similar local state. Prefer syncing vault content across devices rather than .obsidian/plugins/weave-epub-reader/ cache files.

Privacy and network

• Reading, rendering, excerpting, and backlinks are local by default; vault content is not uploaded proactively.
• Bookshelf, backlink, and source-locate features enumerate vault file paths locally; copying excerpts or activation codes uses the clipboard. See PRIVACY.md.
• Premium support activation may contact the license service (activation code, email, device fingerprint summary, etc.). See PRIVACY.md.
• If you use the AI menu through the Weave main plugin, it calls the third-party services you configure; the reader itself does not provide AI features (see FAQ item 3).

FAQ

1. How do I capture reading excerpts correctly?

Excerpts are stored at concrete locations in the Markdown, Canvas, or Weave deck files you choose. The reader aggregates source links from those captures and renders highlights in the book. Selections that are not saved this way only flash briefly and leave no durable data. The in-reader tutorial banner explains this in more detail.

2. How does this relate to Weave?

Weave EPUB Reader works on its own: without the Weave main plugin, you can still read EPUBs, use the bookshelf, and capture excerpts with in-body rendering. With Weave installed, you can also connect spaced-repetition cards, incremental reading calendar, AI actions, and inherit Weave licensing for Premium support. The two are optional companions, not a hard dependency.

3. Does the reader integrate AI?

At this stage, we do not plan to integrate AI into the reader plugin. The vision is to give you a clean, immersive reading environment in Obsidian, with smooth natural interaction and comfortable text editing. We do not intend to use AI for auto-parsing, summarization, or conversational assisted reading. In most cases, that would disrupt your reading rhythm, scatter your focus, and get in the way of deep thinking while you read.

If you need AI, you can copy content, export the current chapter as an MD file, or use the plugin API to fetch chapter text and excerpt notes, then combine with other AI-capable plugins for whatever automated workflows you want. The API exists for exactly that purpose.

4. Can excerpts and notes sync across platforms?

Yes. Captures live in Markdown, Canvas, deck files, and other vault content, so they follow whatever Obsidian sync you already use (Obsidian Sync, iCloud, cloud-synced vaults, etc.) across desktop and mobile. Sync vault content; reader cache under the plugin folder usually does not need cross-device sync (see Data and sync above).

5. Can I export my notes?

Yes. Excerpt and highlight data stays in your vault—you can read, edit, and export Markdown in Obsidian, and the reader offers chapter export and related tools. Data is local by default; your vault is not uploaded proactively.

6. Why is Premium support paid?

Premium support funds ongoing development so the reader and excerpt workflow can keep improving. The essential experience is free—daily reading, five highlight colors, thoughts, excerpts, and in-body rendering are fully usable without paying. Enable Premium support only when you want the library-wide excerpt timeline, two-way tracing, paragraph reading mode, and other advanced capabilities.

7. Subscription or one-time purchase?

Premium support is buy-once (activate once, use long-term; see Premium support terms), not a monthly subscription.

8. How do I change font and size?

By default the reader follows Obsidian's text font and size. Open Typography in the reader menu and enable Custom body font and size to choose a preset font and adjust size (as a percentage of Obsidian's baseline). When Use publisher styles is on, the book's original fonts apply.

9. How do I change the background color?

The reader background follows the active Obsidian theme. Install and switch themes; the plugin does not set a background of its own.

More documentation

• Introduction (Simplified Chinese)
• Introduction (Traditional Chinese)
• Español · Français · العربية
• Privacy · Premium support terms · Support · Security

License and author

Source code is released under GPL-3.0-or-later.

• Author: Rabbit (zhuzhige)
• GitHub: https://github.com/zhuzhige123

中文文档

插件介绍

Weave Epub Reader 为 Obsidian Weave 插件系列下的一款完全服务于 Obsidian、并随 Obsidian 全平台使用的阅读器插件。支持免费提供 EPUB、TXT、FB2/FBZ、MOBI、AZW3、CBZ、PDF 等多格式书籍阅读与多标注类型的摘录笔记体验。摘录可保存在 Markdown、Canvas、Weave 牌组文件中，通过溯源链接在笔记与原书之间跳转，数据完全本地化。

基础体验覆盖日常阅读、书架管理、摘录汇总、书籍数据页模板与正文回显；高级支持在此基础上提供全书架摘录时间线、双向溯源、段落阅读 / 沉浸式全屏、生词标注与学习等进阶能力，旨在 Obsidian 中利用工具，促进思考，磨砺思维，诠释存在。

提示：若有问题，欢迎通过邮箱反馈交流 [email protected]

最低 Obsidian 版本：1.8.7

基础体验与高级支持

图例：✅ 已包含 · 🔒 需启用高级支持

• 启用高级支持：在阅读器设置中使用 EPUB 独立激活码；若已安装并激活 Weave 主插件，可继承授权而无需重复输入。
• 制卡 / 增量阅读 / AI：不单独占用阅读器高级支持许可，但需安装 Weave；AI 另需自行配置 API Key。

激活在阅读器设置中完成，条款见 PREMIUM_TERMS.md。

安装

方式一：社区插件（推荐）

1. 打开 设置 → 社区插件 → 浏览
2. 搜索 Weave EPUB Reader，安装并启用

方式二：手动安装

1. 从 GitHub Releases 下载与 manifest.json 版本号一致的发布包，获取：
   • main.js
   • manifest.json
   • styles.css
2. 复制到 .obsidian/plugins/weave-epub-reader/
3. 重启 Obsidian，在 设置 → 社区插件 中启用 Weave EPUB Reader

快速开始

1. 启用插件后，通过功能区图标或命令面板打开书架，从 Vault 导入或打开图书。
2. 新建或打开一个 Markdown 文件，把光标放在需要插入摘录的位置；启用阅读器的自动摘录。选中文本，创建高亮、摘录或书签，内容会自动写入该位置。
3. 点击正文中的高亮，在工具条中跳转到来源笔记；在保存摘录的 Markdown / Canvas 中点击摘录旁的书籍图标，即可回到书中对应位置。
4. 阅读器菜单 → 帮助 → 使用教程 可查看插件内精简教程；常见问题第 1 条补充了工作流细节。

数据与同步

建议同步（位于 Vault）：图书文件、Markdown 摘录、Canvas、Weave 牌组数据，以及每本书的进度与书签专有笔记（默认 Weave EPUB Reader/data_*.md）。

通常不需跨设备同步（位于插件目录）：阅读缓存、索引、Canvas 绑定与参考阅读点等本地状态。多设备使用时优先同步 Vault 内容，而非直接同步 .obsidian/plugins/weave-epub-reader/ 下的缓存文件。

隐私与网络

• 阅读、渲染、摘录与回链等默认在本地完成，不会主动上传 Vault 内容。
• 书架、回链与来源定位等功能会在本地枚举 Vault 文件路径；复制摘录或激活码时会访问剪贴板。详见 PRIVACY.md。
• 高级支持激活可能访问许可证服务（激活码、邮箱、设备指纹摘要等），详见 PRIVACY.md。
• 若通过 Weave 主插件使用 AI 菜单，会调用你自行配置的第三方服务；阅读器本身不提供 AI 功能（见常见问题第 3 条）。

常见问题

1. 如何正确的做阅读摘录笔记？

阅读摘录笔记保存在你选择的 Markdown、Canvas，以及 Weave 牌组文件中的具体位置；阅读器通过汇总这些摘录中的溯源链接，在正文中回显高亮。若不满足上述保存条件，选中摘录只会短暂高亮，不会留下可同步的实质数据。阅读器顶部的教程浮窗有更详细的说明。

2. 与 Weave 的关系？

Weave EPUB Reader 可独立使用：不安装 Weave 主插件，也能在 Obsidian 里阅读 EPUB、管理书架，并完成基础摘录与正文回显。安装 Weave 后，可额外衔接制卡复习、增量阅读月历、AI 菜单等能力，并可继承 Weave 授权以启用阅读器高级支持。二者是可选联动，不是硬性依赖。

3. 是否集成 AI？

现阶段，并不考虑在阅读器插件中集成 AI 能力。愿景是在 Obsidian 中为你提供干净、沉浸式的阅读环境，流畅自然的功能交互设计，以及舒适的文本编辑体验。无意于通过 AI 满足自动解析、总结或对话式辅读等功能需求。多数情况下该实现可能打乱你的阅读节奏，分散阅读专注，影响阅读过程中的深度思考。

如有需要，可复制内容、导出当前章节为 MD 文件，或通过插件提供的 API 功能获取章节内容、摘录笔记等，协同其它具有 AI 能力的插件使用，实现各种自动自定义的内容。而 API 功能正是为此而设计的。

4. 摘录笔记能否全平台同步？

支持。 摘录落在 Vault 内的 Markdown、Canvas、牌组等文件中，会随你使用的 Obsidian 同步方式（官方 Sync、iCloud、网盘同步 Vault 等）在桌面端与移动端之间保持一致。建议同步 Vault 内容；阅读器缓存等插件目录数据通常无需跨设备同步（见上文 数据与同步）。

5. 是否支持导出笔记？

支持。 摘录与高亮相关数据保存在你的库内，可在 Obsidian 中直接查看、编辑与导出 Markdown；阅读器也提供章节导出等能力。数据默认完全本地化，不会主动上传你的 Vault 内容。

6. 为何提供高级付费？

高级支持用于支持持续开发——让开发者能长期投入、打磨阅读与摘录细节。基础体验免费，已覆盖日常阅读、五色高亮、想法、摘录与正文回显等核心能力，上手体验完整；若你需要全书架摘录时间线、双向溯源、段落阅读模式等进阶能力，再按需启用高级支持即可。

7. 是订阅还是买断？

阅读器高级支持采用买断制（一次激活，长期使用，具体以 高级支持条款 为准），而非按月订阅。

8. 如何调整字体与字号？

默认跟随 Obsidian 外观中的正文字体与字号。在阅读器菜单打开排版设置，启用「自定义正文字体与字号」后，可选择预设字体并调节字号（相对 Obsidian 基准的百分比）。若开启「出版商样式」，则沿用 EPUB 原书字体。

9. 如何更换背景色？

阅读器背景色随当前 Obsidian 主题自动适配。安装并切换不同主题即可，插件不会单独设置背景色。

更多文档

• 插件介绍（简体中文）
• 插件介绍（繁體中文）
• Español · Français · العربية
• 隐私说明 · 高级支持条款 · 支持 · 安全

许可证与作者

源码基于 GPL-3.0-or-later 发布。

• Author: Rabbit (zhuzhige)
• GitHub: https://github.com/zhuzhige123