Weave Reader

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

English Documentation

Overview

Weave Reader embeds reading into Obsidian’s knowledge workflow: immerse yourself in multi-format ebooks inside your vault; excerpts and thoughts can go into Markdown, Canvas, or the Weave memory system, with book anchors so notes and source text jump to each other. Typography can follow Obsidian; excerpt and bookshelf data live in your vault files—not locked inside a closed reading app.

It is a reader in the Obsidian Weave plugin series (exactly three plugins: Weave Deck, Weave Reader, and Weave Incremental Reading). It works standalone—Weave Deck is optional.

Minimum Obsidian version: 1.8.7. Desktop and mobile are supported.

Tutorials: EPUB Reader tutorials. Pricing: Website · Pricing.

Essential experience and Premium support

Daily reading, bookshelf, excerpts, book data page templates, and in-body rendering are free. Premium unlocks advanced review and immersion tools.

Legend: ✅ included · 🔒 requires Premium support

• Enable Premium support: EPUB-only activation code in reader settings; if an activated Weave Deck is installed, authorization can be inherited. Reader Premium is also included in the Weave series activation code. Terms: PREMIUM_TERMS.md.
• Card making / incremental reading / AI: do not consume a separate reader Premium license, but require Weave Deck where applicable; AI needs your own API key.

Core features

Bookshelf and formats

Open My bookshelf from the ribbon or command palette. Import vault books, browse covers and progress, search/filter, and track reading status. Free formats include EPUB, TXT, FB2/FBZ, MOBI, AZW3, CBZ, and PDF.

See: Install & bookshelf.

Reading modes and typography

Use TOC jump, dual-page or continuous scroll, and typography that follows Obsidian or custom body font/size / publisher styles. Progress is persisted with the bookshelf.

See: UI & modes.

Excerpts and highlights

Five highlight colors, thoughts, auto excerpt, screenshot excerpt, card list, and current-book timeline. Excerpts must be saved into Markdown, Canvas, or Weave decks to leave durable data and in-body rendering.

See: Excerpt workflow.

Trace and navigation

Bookmarks and reference points help you return to a place in the book. Premium adds two-way tracing, library-wide timeline, chapter marks, and book-map density.

See: Two-way tracing.

Advanced reading (Premium)

Paragraph reading / immersive fullscreen, vocabulary marking, background glow, bookshelf playlists, and advanced Markdown export.

See: Paragraph & immersive.

Installation

Option 1: Community plugins (recommended)

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

Option 2: Manual installation

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

Quick start

1. Enable the plugin, open the bookshelf, 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. Select text to create highlights, excerpts, or bookmarks.
3. Click a highlight in the book to jump to its source note; in the Markdown / Canvas that holds the excerpt, click the book icon to return to the passage.
4. Reader menu → Help → Tutorial for the in-app guide.

More detail: Intro tutorials.

Data and privacy

Good to sync (in the vault): book files, Markdown excerpts, Canvas, 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. Prefer syncing vault content across devices.

• Reading, rendering, excerpting, and backlinks are local by default; vault content is not uploaded proactively.
• Premium activation may contact the license service. See PRIVACY.md.
• AI via Weave Deck uses third-party services you configure; the reader itself does not provide AI.

See: Settings & sync.

Weave family

Exactly three Weave plugins, composing read → capture → schedule → review:

See: Weave integration.

FAQ

1. How do I capture reading excerpts correctly?

Excerpts must be stored in Markdown, Canvas, or Weave deck files you choose. The reader aggregates those source links and renders highlights in the book. Selections that are not saved this way only flash briefly.

2. Do I need Weave Deck?

No. You can read, manage the bookshelf, and capture excerpts with in-body rendering alone. Deck adds spaced-repetition cards, incremental-reading calendar hooks, AI actions, and license inheritance.

3. Does the reader integrate AI?

Not in the reader itself. Keep a clean reading environment; use copy/export/API with other AI plugins if needed.

4. Can excerpts sync across platforms?

Yes—they live in vault files and follow Obsidian Sync / iCloud / cloud-synced vaults. Prefer syncing vault content, not plugin-folder cache.

5. Can I export my notes?

Yes. Data stays in your vault; chapter export and related tools are available.

6. Why is Premium paid? Subscription or buy-once?

Premium funds ongoing development. Essential reading/excerpt flow is free. Premium is buy-once (see PREMIUM_TERMS.md), also available via the series code.

7. How do I change font, size, or background?

Typography defaults to Obsidian; enable custom body font/size in the reader menu. Background follows the active Obsidian theme.

More: FAQ. Email: [email protected].

More documentation

License and author

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

• Author: Rabbit (zhuzhige)
• GitHub: https://github.com/zhuzhige123
• Email: [email protected]

中文文档

插件概述

Weave Reader 把阅读嵌进 Obsidian 的知识工作流：在库内沉浸阅读多格式电子书，摘录与想法可写入 Markdown、Canvas 或 Weave 记忆体系，并保留书籍锚点以便笔记与原文互相跳转。排版可跟随 Obsidian；摘录与书目数据落在库文件中，而不是锁进封闭阅读 App。

它是 Obsidian Weave 插件系列中的阅读器（系列有且仅有三款：Weave Deck、Weave Reader、Weave Incremental Reading），可独立使用，不强制安装 Weave Deck。

最低 Obsidian 版本：1.8.7。桌面端与移动端均可用。

完整教程见官网：EPUB Reader 教程。价格见 官网 · 价格。

基础体验与高级支持

日常阅读、书架、摘录、书籍数据页模板与正文回显免费可用。高级支持解锁跨书回顾、双向溯源、段落阅读等进阶能力。

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

• 启用高级支持：在阅读器设置中使用 EPUB 独立激活码；若已安装并激活 Weave Deck，可继承授权。亦可使用 Weave 系列激活码。条款见 PREMIUM_TERMS.md。
• 制卡 / 增量阅读 / AI：不单独占用阅读器高级支持许可，但需安装 Weave Deck（如适用）；AI 另需自行配置 API Key。

核心功能

书架与格式

通过功能区或命令打开我的书架，导入库内图书，管理封面、进度与筛选。免费支持 EPUB、TXT、FB2/FBZ、MOBI、AZW3、CBZ、PDF 等。

详见：安装与打开书架。

阅读模式与排版

目录跳转、双页或连续滚动；排版可跟随 Obsidian，或自定义正文字体 / 字号 / 出版商样式。进度与书架同步持久化。

详见：界面与阅读模式。

摘录与高亮

五色高亮、想法、自动摘录、截图摘录、卡片列表与当前书时间线。摘录须写入 Markdown、Canvas 或牌组，才会留下可同步数据与正文回显。

详见：摘录工作流。

溯源与导航

书签与参考阅读点帮助回到原位。高级支持提供双向溯源、全书架时间线、章节标记与全书地图密度条。

详见：双向溯源。

进阶阅读（高级）

段落阅读 / 沉浸全屏、生词标注、透光渐变、书架书单与高级 Markdown 导出。

详见：段落与沉浸。

安装指南

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

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

方式二：手动安装

1. 从 GitHub Releases 下载与 manifest.json 版本一致的：
   • main.js
   • manifest.json
   • styles.css
2. 复制到 .obsidian/plugins/weave-epub-reader/
3. 重启 Obsidian 并启用 Weave Reader

快速上手

1. 启用插件后打开书架，从 Vault 导入或打开图书。
2. 新建或打开 Markdown，把光标放在插入位置；启用自动摘录，选中文本创建高亮 / 摘录 / 书签。
3. 点击正文高亮跳转到来源笔记；在摘录旁点书籍图标回到书中对应位置。
4. 阅读器菜单 → 帮助 → 使用教程 查看插件内精简教程。

更细步骤：教程入口。

数据与隐私

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

通常本地（插件目录）：阅读缓存、索引、Canvas 绑定、参考阅读点等。多端优先同步 Vault。

• 阅读、渲染、摘录与回链默认本地，不主动上传 Vault 内容。
• 高级支持激活可能访问许可证服务，见 PRIVACY.md。
• 经 Weave Deck 使用 AI 时调用你配置的第三方服务；阅读器本身不提供 AI。

详见：设置与同步。

与 Weave 系列

系列共三款插件，围绕 读 → 记 → 排 → 复习：

详见：与 Weave 协同。

常见问题

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

摘录须保存在你选择的 Markdown、Canvas 或牌组文件中；阅读器据此回显正文高亮。未按此保存的选区只会短暂闪一下。

2. 必须安装 Weave Deck 吗？

不必。 单独即可阅读、管理书架并完成摘录与正文回显。Deck 用于制卡复习、增量阅读衔接、AI 菜单与授权继承。

3. 是否集成 AI？

现阶段不在阅读器内集成 AI。需要时可复制 / 导出章节，或用公开 API 配合其它 AI 插件。

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

支持。 数据在 Vault 内，随 Obsidian Sync / iCloud / 网盘库同步。优先同步 Vault，而非插件缓存。

5. 是否支持导出笔记？

支持。 数据在库内可直接编辑；阅读器亦提供章节导出等能力。

6. 为何付费？订阅还是买断？

高级支持用于持续开发；基础阅读与摘录免费。采用买断制（见 PREMIUM_TERMS.md），亦可购买 系列激活码。

7. 如何改字体、字号或背景？

默认跟随 Obsidian；可在排版设置中自定义正文字体与字号。背景随当前主题变化。

更多见官网：常见问题。邮箱：[email protected]。

更多文档

许可证与作者

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

• 作者：Rabbit (zhuzhige)
• GitHub：https://github.com/zhuzhige123
• 邮箱：[email protected]