ShuyoNote 数友笔记

本地优先的类 Notion 生产力工具：知识库 + 项目管理
基于 Tauri 2 + Lexical + SQLite，数据完全存储在本机，离线可用；块编辑器、数据库视图、看板拖拽、原生甘特图、AI 助手、语义检索，支持多设备同步与全平台（浏览器 / 桌面）运行。

---

在线试用

无需安装，直接在浏览器里体验：

• 国际 / GitHub Pages：https://shuyonote.github.io/ShuyoNote/
• 国内 / 自托管主站：https://shuyo.cn/app/

Web 版与桌面版共用同一套前端与数据模型（浏览器端本地优先、离线可用，用 sql.js + IndexedDB）。多设备 / 团队同步需在桌面版配置自建 shuyonote-sync-server 后使用。

为什么选 ShuyoNote

• 数据是你自己的：数据全部保存在本机 SQLite，离线可用、无需注册、无云端依赖；支持 Markdown 导出 / 整库备份 / 单空间导出，随时带走。本地优先、数据主权是它的根。
• 不只是笔记，是知识工作台：块编辑器 + 属性数据库（8 视图：表格 / 画廊 / 看板 / 日历 / 时间轴 / 目录 / 原生甘特图）+ 块级引用 / 关系图 + 双向链接；内置 PDF 批注 · 离线 OCR · AI 视觉识别 · AI 目录。
• 内置网盘：文件夹即网盘——批量上传超大文件（流式）、文件管理页（类型 / 大小 / 时间）、文件引用到页面（文件卡片 / 系统打开）、同名文件历史版本；内容寻址去重存储。
• 安全可靠，不只是"记一下"：自动保存 + 版本历史（可回滚）+ 回收站；端到端加密（Argon2id + XChaCha20-Poly1305，口令解锁/锁定）；存储管理 / 清理。
• AI 可选、本地优先：可接本地 Ollama / OpenAI 兼容端点，默认关闭（隐私）；语义检索 + 流式内联起草 + 侧边栏问答 + 思考过程流式。
• 独有的邮箱聚合：打通多账号 IMAP，邮件即笔记——聚合收件箱、按账号/月份筛选、一键存为笔记 / 任务、AI 总结。
• 免费 + 开源：核心功能永久免费；客户端 AGPL-3.0 开源，插件、主题、模板可扩展。
• 可自托管、多设备同步：多设备 / 团队同步用自建 shuyonote-sync-server（无云锁定，可私有部署）；outbox 增量 + 服务端 seq 基准的 LWW 合并（多端同时改同一内容也不丢改动）。
• 全平台：桌面（Tauri + Rust）+ 浏览器（Web）同一套前端；同一份数据两端可用。

截图 / 演示

新页面 · 数据库 · AI 助手

全文检索 · 语义检索 · 上手引导

块级关系图

PDF 阅读 · 批注 · 离线 OCR · AI

数据库（表格 / 看板 / 画廊 / 日历 / 时间轴 / 目录 / 甘特图）、块级引用 / 关系图、PDF 批注 · 离线 OCR · AI 视觉识别、AI 助手 / 内联起草、全局搜索 · 语义检索、公式、绘图——详见下方特性。

快速开始

git clone https://gitcode.com/shuyo-cn/ShuyoNote.git
cd ShuyoNote
pnpm install          # 安装依赖

pnpm tauri dev        # 桌面（Tauri）
pnpm dev:web          # 浏览器（Web 平台，独立 5173）

Windows 提示：若 cargo 使用镜像源且遇到 SSL 撤销错误（如 USTC），先执行 $env:CARGO_HTTP_CHECK_REVOKE="false" 再运行。

首次启动会在应用数据目录（Windows：%APPDATA%\cn.shuyo.shuyonote\，WAL 模式）创建：meta.db（应用级：空间 / 同步 / 模板 / 插件状态）+ spaces/<ws_id>/（每空间独立库）+ attachments/（全局内容寻址附件）。Web 版则在浏览器 IndexedDB 中持久化（shuyonote 存 SQLite 快照、shuyonote-blobs 存附件字节、shuyonote-spaces 存多空间 catalog + 快照）。

支持

如果 ShuyoNote 对你有用，欢迎 点个 Star，或 参与开发（AGPL-3.0）。自托管 / 团队同步见下方「多设备同步」。

---

特性

编辑体验

• 块编辑器：基于 Lexical，支持标题、引用、Callout、代码块、列表、待办、表格、分隔线等 12 种块类型。
• 「+」插入块（飞书式）：光标悬停在空块时，该块左侧出现内联「+」，点开即弹出飞书式分组插入面板（基础 / 列表 / 媒体 / 嵌入 / 引用，图标 + 名称 + 顶部可搜索），点某项即在该空块处插入对应块；面板右上置顶「AI 帮我写」入口。非空块显示 ⋮⋮ 拖拽手柄（空块显示 +、非空块显示 ⋮⋮，两者同位、中心对齐）。已取代旧版顶栏「+」按钮。
• 分栏（飞书式）：N 列并排（2–4 栏，/分栏 或「+」菜单的分栏项插入，选栏数 2/3/4）；每列是独立子编辑器——独立输入与独立撤销（HistoryPlugin），互不影响；列内 / 可插标题/正文/引用/Callout/列表/表格/代码块/分隔线；列右上角 ＋/× 增删列（insertColumnAt 末尾追加），列间手柄拖拽调整列宽并实时显示各列占宽百分比（最大余数法恒 100%）；列内空行悬停「+」插入块（220ms 驻留防闪现）；支持深色模式、随主题变色、列内容并入全文搜索与 Markdown 导出。
• 斜杠菜单：输入 / 快速插入任意块（含 /引用块、/嵌入块）。
• 块拖拽排序：悬停块左侧出现 ⋮⋮ 手柄，拖拽实时显示插入指示线，松手重排。
• 块多选：点击 ⋮⋮ 手柄选中块（Shift 选连续范围），批量操作条「复制 / 删除」，Delete/Esc 快捷键，选中块高亮。
• 表格交互：悬浮工具栏（增删行列 / 表头行列切换 / 对齐 / 背景色）+ 列宽拖拽调整 + 单元格选区高亮。
• 图片粘贴：截图 / 复制图片直接粘贴，内容寻址（SHA-256）去重存储。
• 网址书签：/wzsq 或 /bookmark 插入 URL 为书签卡片（自动抓取 Open Graph 标题 / 摘要 / 预览图）；粘贴纯网址可一键「转换为网址书签」；预览图复用附件内容寻址存储。
• 文件附件：通用文件附件（多选导入、超大文件流式存取、打开 / 定位 / 移除）。
• Markdown：快捷键输入、一键导入 / 导出、导出 HTML。
• 数学公式：块级 /公式（或 $$…$$）与行内 $…$，渲染为 KaTeX（懒加载）；公式编辑器有希腊字母 / 运算符 / 关系式 / 式子 / 箭头 / 化学六类符号面板；左下 (图) / (笔) 可识别图片中的公式（上传/拖入/粘贴 → 自动转 LaTeX）与识别手写公式（手写板 → 自动转 LaTeX），需在 AI 设置配置支持图像的模型。

PDF 阅读

• 完整 PDF 阅读器：内置打开 PDF（点击附件/文件树直达），近全屏阅读器 + 整篇连续滚动（虚拟化） + 左侧目录树 / 右侧批注侧栏 + 键盘导航（←/→/↑/↓ 平滑） + PageUp/PageDown 翻页 + 缩放下拉（适配页宽/页面/内容/实际 + 百分比阶梯）+ 护眼模式（柔光/暖黄/夜间/淡绿多档位，暖色纸底 + 页图降蓝/柔光）。
• 页面批注：高亮（有文本层精确划词）/ 画笔 / 便签（钉 + 内容气泡，按住即拖、双击编辑）/ 区域标注；选中标注 → 摘录成块（带 pdf:// 回链）/ AI 帮读 / 复制引用 / 删除；撤销；右侧批注侧栏（类型筛选、按页、点击精准定位、及时刷新）。
• 扫描版 OCR / AI 识别：无文本层时点「OCR 识别本页」用本地离线 tesseract（双语完整模型，免联网），或点「AI 识别」把页图直接给视觉大模型（更准）；识别结果在居中可缩放弹层显示，可朗读 / 复制全部 / 写入便签。
• AI 一键生成目录：扫描版无内置目录时，从当前页往后逐页用视觉大模型看页识别章节标题+页码，一键生成可点击跳转的目录（进度 / 取消 / 缓存）。
• 系统朗读：顶部「朗读本页」（有文本层读全文；扫描版先识别再听），识别结果也可朗读。

知识组织

• 页面树：无限层级嵌套，页面与文件夹（kind）区分，拖拽精确排序。
• 文件管理 / 网盘：从侧边栏点文件夹进入文件管理页——文件 / 文件夹、文件列表（类型、大小、时间），文件夹内批量上传超大文件（流式）、侧边栏同步展示；文件引用到页面（文件卡片 + 系统打开）；同名文件历史版本（保留 / 恢复）。
• 标签系统：页面打标签，侧边栏按标签筛选；标签管理（全局标签库，重命名合并 / 删除 / 使用页数）。
• 双向链接：[[标题]] 页面双链 + ((块ID)) 块引用 + {{块ID}} 块嵌入。
• 块级反链：页面底部反链面板分「页面引用 / 块级引用」两组，精确到「谁引用了本页哪一块」。
• 关系图：力导向关系图，页面 / 块节点、按引用类型着色、块级图层开关、拖拽与点击跳转。
• 数据库视图：表格 / 画廊 / 看板 / 列表 / 日历 / 时间轴 / 目录 / 甘特图 八种视图；查询型数据库（规则收页）、保存视图 + ref 关联属性 + 公式列 + 跨库 rollup 聚合。
• 原生甘特图：用日期列（开始/结束，或 4 列计划/实际两组）渲染网格填色甘特图——时间轴、网格线、可编辑日期（文本+日期选择器）、列宽可拖；数据表格一键变专业甘特图。
• 看板视图：按标签 / 分组字段分列；卡片跨列拖、列(分组)拖换序、插入位置竖线、未设置列固定最左——像专业看板工具，而不只是"按字段分组"。
• 语义检索：嵌入向量语义搜索，不只关键词——全空间、跨空间找得到"想表达的意思"，与 AI 助手联动。
• 全文搜索：SQLite FTS5 + trigram 分词，支持中文子串检索、命中高亮与定位；Web 平台提供相关度排序版本。
• 多工作空间（物理隔离）：每空间独立 SQLite 库（meta.db 管理空间清单，spaces/<ws_id>/ 每空间库）；空间切换器（新建 / 重命名 / 主题色 / 排序 / 删除）；全空间搜索跨库合并；跨空间复制页面；单空间导出 / 导入（自包含 zip）。

邮件聚合（邮件即笔记，v1.83.0）

• 多账号聚合收件箱：打通 QQ / 企业邮箱等多账号 IMAP，聚合到一个统一收件流（按时间降序、分页）；单账号连接失败跳过。
• 账号筛选：「全部账号 + 每账号」多选下拉，选哪些账号就聚合哪些；列表新增独立账号列（多账号才显示），未读角标用聚合汇总。
• 按月直达：月份选择器聚合各账号含邮件月份，所有月份可点，按邮件自身时区年月在后端过滤（不依赖服务端 SINCE/BEFORE）。
• 存为笔记 / 任务：单封 / 任务 / AI 总结 / 批量四条路径统一先写属性再跳转，自动填发件人 / 主题 / 邮件日期 + 发件人标签，不因竞态丢失。
• AI 总结：阅读区一键总结，结果在弹窗展示；「存入笔记」自动填属性 + 发件人标签。
• 回复 / 转发：转发可输入收件人、光标自动定位；回复 / 转发光标定位正文最前。
• 测试连接：设置 → 邮箱多账号管理里「测试连接」（IMAP 登录 + 选 INBOX + 可选 SMTP 认证，不发信）。

数据安全

• 自动保存：防抖写入 SQLite，无「保存」按钮。
• 版本历史：每次保存前自动快照，可一键回滚（每页保留 50 份，自动去重）。
• 回收站：软删除 + 恢复 + 彻底删除。
• 端到端加密：Argon2id 密钥派生 + XChaCha20-Poly1305；同步加密 + 设置 UI + 口令解锁 / 锁定，每空间独立密钥。
• 整库备份：导出 / 导入 zip（数据库一致性快照 + 附件目录；流式 + 进度条）。
• 单空间备份导出：export_workspace 把当前空间打成自包含 zip（空间库 + 该空间引用附件 + 元数据）；import_workspace 导入为新空间。
• 空间清理 / 存储管理：占用统计（数据库 / 附件 / 回收站 / 版本 / 临时）、清空回收站 / 清理孤立附件 / 清理版本历史 / 清理临时文件 / 清理软删工作空间。

多设备同步

• Outbox 变更日志：本地每次写入记录变更，离线排队。
• 同步一致性加固（seq-LWW + dirty 优先本地，v1.84.3）：LWW 改用服务端单调 seq 为权威序，配合 dirty 优先本地——根治团队多人同时改同一内容时因客户端时钟漂移而丢改动的隐患。服务端 changes 自增 seq 全局唯一、单调；本地未提交改动标 dirty 优先保留，推送成功才清除。
• 附件同步：内容寻址去重，双向增量。
• 自动定时同步：启动即同步，之后每 5 分钟周期同步。

体验优化

• 设计系统 v2：品牌蓝 + 中性面 + 多彩分类色的统一 token 体系。
• 暗色模式：亮色 / 暗色 / 跟随系统三种。
• 命令面板：Ctrl+K 搜索页面与命令，分组展示、键盘导航。
• 顶部工具栏：页面顶部图标工具栏（查找 / 导入 / 导出 Markdown / 导出 HTML / 版本历史 / PDF）。
• 模板中心：结构预设建页（页面 / 数据库）+ 保存为模板 + 共享打磨。
• Toast 反馈：保存 / 同步 / 备份 / 删除 / 恢复等操作底部提示，替代系统弹窗。
• 编辑器查找：Ctrl+F 高亮全部命中并逐个导航。
• 多窗口：页面可弹出到独立窗口编辑。

AI 助手（薄 Agent + 内联起草）

• 可选、本地优先、安全：AI 默认关闭，仅调用你配置的模型端点（本地 Ollama / OpenAI 兼容云）；白名单语义工具（搜索 / 读页 / 读块 / 建页 / 追加块 / 反链），无 shell / 任意文件 / 联网；写操作需确认（详见 薄 Agent 方案）。
• 侧边栏 AI 助手：右侧 (AI) 面板，全局问答 / 总结 / 跨页检索 / 建页（草稿确认后落库），多轮上下文（支持"再详细点"）。
• 内联 AI 起草：空行按空格打开跟随光标的起草浮层；「用 AI 写作」下拉按当前页上下文自适应（有内容 → 续写 / 总结 / 翻译 / 润色 / 纠错；空页 → 创作类·小红书等）；选中即填入提示词、光标定位到省略号后；流式创作 + 高亮待定草案 +「完成」插入到你按空格所在的块 /「关闭」丢弃 /「重新生成」；点击背景或 Esc 取消。
• 思考过程实时流式：推理型模型的 reasoning_content 边想边显示；R 重新生成 / Esc 停止。

快捷键

快捷键	功能
Ctrl+N	新建页面
Ctrl+Shift+F	聚焦搜索
Ctrl+E	循环笔记 / 看板 / 关系图视图
Ctrl+K	打开命令面板
Ctrl+F	编辑器内查找（Enter / Shift+Enter 导航）
Esc	关闭查找栏 / 命令面板 / 弹层
/	打开斜杠菜单

架构

详细架构见 docs/architecture.md。

flowchart TB
    subgraph FE["前端 · React 18（同一套代码）"]
        UI["Lexical 编辑器 · Zustand stores · 各视图 / 面板组件"]
        API["api.ts —— 只调 platform.executor.invoke"]
        UI --> API
    end

    subgraph DRV["平台 driver 抽象 · src/lib/platform/"]
        T["tauri.ts · driver A（桌面）"]
        W["web.ts · driver B（浏览器）"]
    end

    API --> T
    API --> W

    subgraph D["桌面运行时 · Tauri"]
        R["Rust 后端 src-tauri<br/>commands · sync · search · attachments<br/>backlinks · blocks · graph · tags · trash<br/>versions · backup · workspace_io · security · plugins"]
        SQL["SQLite（rusqlite · WAL + FTS5）<br/>meta.db + spaces/ws_id.db"]
        ATT["附件目录 · SHA-256 内容寻址"]
        T --> R
        R --> SQL
        R --> ATT
    end

    subgraph WB["浏览器运行时 · Web"]
        SQ["sql.js WASM · 真实 SQLite"]
        IDB["IndexedDB · shuyonote<br/>SQLite 快照 + blobStore 附件<br/>+ spaceStore 多空间"]
        W --> SQ
        SQ --> IDB
    end

    subgraph SYNC["同步服务端 · shuyonote-sync-server（独立二进制）"]
        SRV["Axum + SQLite<br/>outbox 变更日志 · LWW 合并 · 附件增量"]
    end

    D -.->|"desktop"| SYNC
    WB -.->|"web（可选）"| SYNC

    classDef fe fill:#4d8dff,color:#fff,stroke:#2952cc,stroke-width:2px
    classDef driver fill:#eef3ff,stroke:#8aa3d8,color:#27406e
    classDef rust fill:#e9edf3,stroke:#8a94a6,color:#20242b
    classDef store fill:#f3ede4,stroke:#c9a566,color:#6b5320
    classDef browser fill:#e6f2ec,stroke:#3f9d63,color:#1f4d34
    class UI,API fe
    class T,W driver
    class R rust
    class SQL,ATT store
    class SQ,IDB browser
    class SRV store

平台 driver 抽象（M16）：src/lib/platform/ 定义 Executor / DialogDriver / OpenerDriver / EventDriver / AssetDriver / WebviewDriver 接口；tauri.ts 为桌面唯一宿主（调用 @tauri-apps/*），web.ts 为浏览器实现（sql.js WASM SQLite + IndexedDB + blobStore 内容寻址附件），index.ts 按环境（是否 __TAURI_INTERNALS__）自动切换。同一套前端可跑桌面与浏览器（pnpm dev:web）。

数据模型：一页 = 一份 Lexical 文档。块映射为 Lexical 根级节点（每个顶层块带稳定 blockId），页面层级用 parent_id 树表达；blocks 表维护「块 → 页」反向索引，backlinks 表记录页面级 + 块级引用关系。

物理隔离：每个工作空间一个独立 SQLite 库（spaces/<ws_id>/），应用级共享状态（workspaces / 模板 / 插件状态 / 同步配置）放 meta.db；附件字节全局内容寻址（跨空间去重），单空间可搬移经空间级附件子集导出实现。

技术栈

层	技术
桌面壳	Tauri 2.x（Rust 后端 + 系统 WebView）；Web 壳 = web.ts + sql.js WASM
编辑器	Lexical 0.50（@lexical/react）
前端	React 18.3.1 · TypeScript · Vite 8（pnpm dev:web：vite.web.config.ts）
状态管理	Zustand
本地存储	SQLite（桌面 rusqlite 0.40 bundled / Web sql.js WASM）· FTS5 / trigram 全文检索
加密	Argon2id + XChaCha20-Poly1305（RustCrypto）
同步	outbox 变更日志 + LWW · reqwest · 自建 Axum 服务端
备份 / 导出	rusqlite 在线 backup API + zip（Web 用 fflate + 流式 Zip）
插件	boa_engine（受限 JS 运行时）+ 白名单 API
附件	内容寻址（SHA-256 去重）；Web 侧存 IndexedDB blobStore
PDF 渲染/批注	pdf.js（Web）+ MuPDF（桌面 native，mupdf-sys）+ 坐标归一化 pdfAnnotation 纯函数
OCR / AI 识别	离线 tesseract.js（ocr.ts，本地双语完整模型）+ 视觉大模型（ai/ocrVision.ts）
朗读 / 目录	Web Speech 朗读（speech.ts）+ AI 生成目录（aiOutline.ts + pdfOutlineGen.ts）

开发环境要求

• Node.js ≥ 20 + pnpm
• Rust stable（1.94+，MSRV 见 src-tauri/Cargo.toml 的 rust-version）与 cargo
• Windows / macOS / Linux

构建发布

pnpm build      # 前端构建（tsc + vite build，产物到 dist/）
pnpm tauri build   # 打包桌面安装包

产物位于 src-tauri/target/release/。

dev/build 前会自动运行 scripts/copy-pdfjs-assets.mjs 与 scripts/copy-tesseract-assets.mjs（PDF CJK 资源 + tesseract 离线 OCR 双语完整模型分别拷到 public/pdfjs、public/ocr，均为生成物、不入库）；pnpm install 后即可离线使用 OCR。

多设备同步

仅桌面版。Web 版（浏览器）不支持多设备同步与团队版，跨设备交换请用备份 / 导出 zip。原因与「若要开启」的路线见 Web 同步能力边界。

客户端（本仓库）是 AGPL-3.0 开源。多设备/团队实时同步需要 shuyonote-sync-server——它是独立的商业授权组件（私有仓库，不随本客户端开源）。部署与使用文档见其仓库 docs/deploy.md（该仓库仅对授权者可见）。

1. 在应用中配置（客户端侧）

本仓库负责的是客户端接入：装好 shuyonote-sync-server 后，到侧边栏「同步」里配置即可。

1. 侧边栏点击「同步」。
2. 填写服务地址（如 http://localhost:8787，跨设备填局域网 IP 或公网地址；官方可用实例 https://shuyo.cn/sync）。
3. 可选填写访问令牌。
4. 点击「立即同步」。

同步机制：本地每次写操作在 changes 表记录 outbox 变更；同步时先 push 本地增量，再 pull 服务端增量。冲突合并采用 LWW（服务端单调 seq 为权威序）+ dirty 优先本地（v1.84.3 起）——根治团队多人同时改同一内容时因客户端时钟漂移而丢失改动的隐患：服务端 changes 自增 seq 作为全局唯一、单调的 LWW 键，本地未提交的改动标记 dirty 优先保留，推送成功才清除。删除走墓碑，附件按内容寻址去重传输。若开启端到端加密，push 前加密、pull 后解密（服务端仅存密文），锁定会话时同步被拒绝。

2. 免费替代：导出 / 导入（无需 shuyonote-sync-server）

不想运行 shuyonote-sync-server？可用内置的导出 / 导入在设备间手动搬运与备份数据（手动快照，非实时同步）：

• 备份 / 恢复（设置 → 备份 / 恢复）：「导出完整备份」生成一份备份包，可在本机或另一台设备「从备份恢复」（覆盖当前数据）。
• 空间导出 / 导入（侧边栏空间菜单 →「导出当前空间」/「导入空间包」）：把单个空间（含其引用的附件）导出为自包含包，在另一台设备新建一个空间导入，不覆盖现有空间。
• 桌面 / Web 互通：桌面导出的包可在浏览器端导入，反之亦然，支持离线搬家。

注意：导出 / 导入是手动、全量快照，多设备各自改动同一空间时不会自动合并。请以一台为主定期导出，或在迁移时自行保留最新版本。

本仓库 README 只讲客户端（AGPL-3.0）；同步服务端的启动/部署文档只放在私有仓库，公开处只给链接，避免读者误以为它属于 AGPL 开源代码。

项目结构

ShuyoNote/
├── src/                      # 前端（React + Lexical）
│   ├── editor/               # 编辑器、自定义节点（Callout/Image/BlockRef/BlockEmbed/ColumnsBlockNode/分栏）、Markdown 转换
│   ├── components/           # 侧边栏、页面树、搜索、看板、关系图、各面板 + 分栏（ColumnsBlockView/ColumnEditor） + PDF 阅读器/批注（PdfReader/PdfAnnotationCanvas/PdfOutline/PdfSidebar/PdfAnnotTopToolbar/PdfAskBar）（18+ 组件）
│   ├── store/                # Zustand（notes / theme / sidebar / toast / view / space / blockCache / treeDrag / treeSelection / …）
│   ├── hooks/                # 自动同步 / 全局快捷键 / Popover
│   ├── plugins/              # 插件命令注册表（命令面板扩展点）
│   ├── lib/                  # Tauri IPC 封装 / 标签分类表 / Markdown 导出 / PDF 打印 / treeReorder(拖拽重排纯函数)
│   │   ├── platform/         # 平台 driver 抽象：types(接口) / tauri.ts / web.ts / sqliteStore.ts / blobStore.ts / spaceStore.ts
│   │   ├── ai/               # 薄 Agent 核心：llm(传输) / host(受限循环) / transport / apply / tools / inlineDraft / lexical(文本辅助) / ocrVision(视觉识别)
│   │   ├── pdf*.ts           # PDF 坐标归一化 / 布局(pdfLayout) / 批注 / 目录纯函数(pdfOutlineGen) / OCR(ocr) / AI 目录(aiOutline) / 朗读(speech)
│   │   └── speech.ts         # 系统朗读（Web Speech）
│   ├── App.tsx               # 根组件
│   ├── App.css               # 设计系统 token 与全局样式
│   └── types.ts              # 共享类型
├── src-tauri/                # Tauri 后端（Rust）
│   └── src/
│       ├── db.rs             # SQLite 连接/迁移；meta.db + spaces/<id>.db 每空间库
│       ├── commands.rs       # 页面 CRUD
│       ├── pdf_native.rs     # PDF native 渲染（MuPDF 经 mupdf-sys）
│       ├── search.rs         # FTS5 检索（含全空间跨库合并）
│       ├── sync.rs           # outbox / LWW / push-pull / 附件同步
│       ├── attachments.rs    # 图片 / 附件（内容寻址）
│       ├── backlinks.rs      # 反向链接
│       ├── blocks.rs         # 块索引 / 块级引用 / 块级反链
│       ├── graph.rs          # 关系图数据
│       ├── tags.rs           # 标签 / 看板
│       ├── trash.rs          # 回收站
│       ├── versions.rs       # 版本历史
│       ├── backup.rs         # 整库备份导出 / 导入
│       ├── workspace_io.rs   # 单空间导出 / 导入（自包含 zip）
│       ├── storage.rs        # 存储统计 / 清理（回收站/孤立附件/版本/临时/软删空间）
│       ├── workspaces.rs     # 工作空间命令 + 跨空间复制
│       ├── templates.rs      # 模板（meta.templates）
│       ├── plugins.rs        # 插件加载（boa 运行时 + 白名单 API）
│       ├── security.rs       # 端到端加密（口令加解密 / 同步门）
│       ├── crypto.rs         # Argon2id + XChaCha20-Poly1305 原语
│       ├── database.rs       # 数据库视图 / 查询型 / 公式
│       ├── properties.rs     # 属性系统
│       └── windows.rs        # 多窗口
│   shuyonote-sync-server → 独立仓库    # 同步服务端（商业授权：shuyo-cn/shuyonote-sync-server）
├── design/                   # UI/UX 设计体系（设计系统 / UX 流程 / 原型 / 实现计划）
├── docs/                     # 产品 / 方案 / 对比文档（见 docs/README.md 索引；架构见 docs/architecture.md）
└── CHANGELOG.md              # 版本变更日志

文档体系

全量文档统一入口：docs/README.md（按主题组织的索引）。

文档	内容
docs/README.md	文档体系总索引：定位 / 架构 / 方案 / 对比 / 设计交付 / 变更记录
docs/SHUYONOTE_STATE.md	项目现状种子（新会话先读）：版本 / M1–M27 里程碑进度 / 近期重大变更 / 关键架构 / 红线 / 验证循环 / 下一步候选（对齐到 v1.84.3）
docs/architecture.md	系统架构：前端 / 平台 driver / Rust 后端 / SQLite / 同步服务端分层；数据模型与存储布局
docs/design-philosophy.md	设计哲学：page 本源 / 属性语义 / 数据库=透镜 / 文件夹=容器 / 空间=隔离容器
docs/roadmap.md	演进路线图与里程碑规划（M1–M26 大部分已达成 + M16 跨平台/Web；M17 薄 Agent AI / M18 内联起草 / M24 PDF 批注与 OCR-AI 增强 / M25 帮助系统 / M26 公式 已达成；M27 团队版规划中；M6 移动端 / M11.3 / M11.4 已评估未做）
docs/development.md	开发指南：运行 / 测试与验证权威循环（scripts/smoke-web.mjs + tsc + vite build + cargo check）/ 版本号提升规则 / 约定 / 常见坑
docs/positioning.md	产品定位陈述、目标用户与差异化
docs/compare-obsidian-siyuan-shuyonote.md	Obsidian / 思源笔记 / ShuyoNote 三方对比与定位
docs/compare-flowus-wolai-notion-shuyonote.md	FlowUs / Wolai / Notion / ShuyoNote 四方对比与定位
docs/plans/*	各功能方案：块引用 / 属性数据库 / 多空间 / 模板 / 插件 / 网盘 / 数据库透镜 / 存储清理 / 工作空间 CRUD / 物理隔离 / 跨平台 / Web 打磨 / 薄 Agent AI / 内联 AI 起草 / PDF 批注 / PDF 连续滚动 / PDF 阅读器 + OCR/AI 增强（含护眼·离线 OCR·视觉识别·AI 目录·朗读）/ 公式（M26）/ 帮助系统（M25）
design/README.md	UI/UX 设计交付索引（设计系统 / UX 流程 / 高保真原型 / 实现计划）
CHANGELOG.md	版本变更日志

路线图

• MVP：页面树 + 富文本 + 自动保存
• 块系统：斜杠菜单 / 待办 / 表格 / Callout
• 「+」插入块（飞书式）：空块悬停出「+」→ 飞书式分组插入面板（基础/列表/媒体/嵌入/引用 + 搜索 + AI 帮我写）；取代旧顶栏「+」按钮；空块「+」与非空块 ⋮⋮ 同位
• 分栏（飞书式）：2–4 列并排 / 每列独立子编辑器独立输入与撤销 / 列内 / 插块 / 列增删与列宽拖拽、实时占宽百分比 / 列内空行「+」插入块（见 分栏方案）
• 全文检索：FTS5 + trigram 中文搜索
• 多设备同步：outbox + LWW + 附件同步
• 标签 / 反链 / 文件库 / 看板
• 回收站 / 版本历史 / 整库备份
• 暗色模式 / 命令面板 / 多窗口
• 块拖拽排序 / 编辑器查找
• UI/UX 设计系统 v2（token / Toast / 分类色 / 命令面板增强 / 骨架屏）
• 表格交互（悬浮工具栏 / 列宽拖拽 / 选区高亮）
• 块级引用 / 块嵌入 / 块级反链
• 关系图（页面 / 块级图层）
• 属性系统 + 数据库视图（表格 / 画廊 / 看板）
• 属性 Notion 风格统一（标签属性行 + 底部「＋ 添加标签 / ＋ 添加属性」双按钮）
• 文件管理视图（文件夹 / 批量超大文件上传 / 侧边栏文件）
• 文件引用到页面（正文插入文件卡片 / 系统默认打开）
• 文件历史版本（同名文件保留 / 恢复）
• 全局标签管理（新建 / 重命名合并 / 删除 / 使用页数）
• 跨空间复制页面（把页面树复制到其他工作空间）
• 工作空间管理（新建种子首页 / 按 id 重命名 / 空间主题色与排序）
• 全空间搜索（本空间 / 全空间切换，跨工作空间全文检索）
• 块多选 + 批量删除
• HTML / Markdown 混排导入（保留 align 居中 / 徽章成排 / 图片尺寸）
• Markdown 无损往返
• 导出工作空间为 Markdown（批量 .md，可 git / 可移植）
• 属性驱动仪表盘聚合
• 端到端加密（Argon2id 派生 + XChaCha20-Poly1305；同步加密 + 设置 UI + 口令解锁/锁定，每空间独立密钥）
• 主题自定义 + 插件启停
• 插件（磁盘加载命令 + 受限白名单 API，可插入内容）
• 数据库视图扩展（列表 / 日历 / 时间轴 / 目录）
• 跨库统计（rollup：数据库列引用另一库的行并聚合 count / sum / avg）
• 新页面引导层（页面 / 数据库 / 模板 / 导入 / AI 入口）
• 导出 PDF（页面 + 数据库视图）
• 每工作空间独立存储（物理隔离：meta.db + spaces/<ws_id>/ 每空间库；全空间搜索跨库合并 / 跨空间复制 / 单空间导出导入）
• Web 全平台（M16：src/lib/platform/ driver 抽象 → 浏览器可跑 → sql.js 真实 SQLite → 属性/数据库/版本/块引用/备份/PWA；web 能力补齐与体验优化 + 数据安全，见 M16 里程碑）
• AI 增强（薄 Agent）（M17：语义工具 + 受限宿主 + 草稿确认 + 隐私开关，默认关，见 方案）
• 内联 AI 起草（M18：空行空格唤起随光标浮层 + 上下文自适应下拉 + 流式创作 + 完成/关闭，见 方案；M19 织网 / M20 模板变量+语义检索 / M21 wiki 导出 / M22 绘图 / M23 Excalidraw 高级均已达标）
• PDF 阅读/批注（M24 阶段1/3：内置阅读器 + 连续滚动 + 高亮/画笔/便签 + 摘录成块（pdf:// 回链）+ AI 帮读 + 对整篇 PDF 提问；见 方案）
• PDF 阅读体验 + OCR/AI 增强（护眼多档位 / OCR 彻底离线 / AI 视觉识别 / AI 一键生成目录（视觉优先、带层级、可范围） / 系统朗读 / 识别结果弹层；见 落地文档）
• 移动端适配（环境受限：缺 iOS/Android 工具链，已评估）

详细演进路线与里程碑，见 docs/roadmap.md。

License

本仓库（ShuyoNote 客户端）以 GNU Affero General Public License v3.0（AGPL-3.0）开源，全文见仓库根 LICENSE。

AGPL-3.0 的要点：无论分发副本，还是通过网络向第三方提供服务，均须以相同许可向接收方提供对应源码——与「本地优先、数据自持、可自建同步」的项目定位一致。

在此许可下，你享有自由使用、修改与分发的权利；对外提供修改版或网络服务时，须遵守上述开源义务。

同步服务端 shuyonote-sync-server 为独立商业组件，按其商业许可分发（见 shuyo-cn/shuyonote-sync-server），不适用本许可。