文档编辑器 — 用户手册 | YoBench
如何在 YoBench 中使用「文档」模块:基于 TipTap 的富文本编辑器、wiki 链接、Mermaid 与 Draw.io、KaTeX、版本历史、AI 助手。
「文档」模块的用途
该模块是 YoBench 内置的功能完整的富文本编辑器,适合内部 wiki、个人笔记与项目文档。底层是 TipTap(基于 ProseMirror):/ 命令菜单、丰富的块集合、Mermaid 与 Draw.io 图表、KaTeX 公式、页面间 wiki 链接、版本历史以及 AI 助手。
您将获得:
- 页面层级 —— 嵌套的文档,带侧栏树与面包屑。
- 富文本编辑器 —— 标题、任务列表、表格、引用、含语法高亮的代码块(28 种语言)、Callout、Toggle、目录、查找替换、emoji 选择器。
- 图表与公式 —— Mermaid、Draw.io(交互式)、KaTeX 数学。
- 媒体 —— 可调整尺寸的图片、YouTube/Vimeo 嵌入、文件附件。
- Wiki 链接 ——
[[页面名称]],带自动补全;反向链接自动追踪。 - 版本历史 —— 每页最多 50 个快照,可恢复。
- AI 助手 —— Summarize、Continue Writing、Translate(8 种语言)、Improve Text。
- 导入/导出 —— Markdown、HTML、ZIP 包;导入
.md会创建新页面。 - 本地存储 —— 所有页面与版本保存在 YoBench 加密数据库中。
- 收藏夹与回收站分页 — 长列表的收藏页面或已删除页面按页加载,侧边栏保持响应。
页面参数
创建或编辑时:
- 标题 —— 显示名称。
- 图标 —— 来自选择器的 emoji。
- 封面图 —— URL(可选)。
- 父级 —— 用于嵌套。
- 标志 —— 收藏、已删除(回收站)、模板。
目前尚未实现标签和分类 —— 通过页面层级和收藏来组织结构。
编辑器功能
格式
- 加粗、斜体、下划线、删除线、行内代码。
- 文本颜色、高亮、上标和下标。
- 对齐(左 / 中 / 右)。
结构块
- 标题 H1、H2、H3。
- 项目符号与编号列表。
- 带复选框的任务列表。
- 引用、代码块(28 种语言,lowlight)。
- 可编辑单元格的表格。
- 水平分隔符。
- Callout 块:Info / Warning / Success / Error。
- Toggle 块(可折叠)。
- 动态目录(TOC)。
高级块
- Wiki 链接 ——
[[页面名称]],对已有页面自动补全。 - Mermaid —— 代码形式的图表。
- Draw.io —— 交互式矢量编辑器。
- KaTeX —— 行内与块级数学。
- 视频 —— YouTube/Vimeo 嵌入。
- 图片 —— 拖拽上传并可调整尺寸。
- 附件 —— 任意文件挂在页面上。
Slash 命令
在编辑器中输入 / 即可打开快速插入菜单:/heading1、/heading2、/heading3、/bulletList、/taskList、/table、/image、/codeBlock、/math、/mermaid、/drawio、/video、/quote、/toggle、/toc、/divider 等。
查找替换、emoji 选择器
标准的查找与替换,以及工具栏中的 emoji 选择器。
版本历史
- 切换到其他页面时,自动创建快照(
docs_page_versions)。 - 每页最多保存 50 个版本,旧的会被自动清理。
- UI 中的 版本历史 列出带时间戳的快照;恢复 会将所选版本设为当前,而当前内容保存为新版本。
AI 助手
编辑器工具栏带有自动改进按钮。可用操作:
- Summarize —— 对所选文本或整页生成简短摘要。
- Continue Writing —— 以相同风格续写。
- Translate —— 翻译为 8 种语言(英语、俄语、德语、西班牙语、法语、葡萄牙语、汉语、日语)。
- Improve Text —— 改善语法与清晰度。
结果可以在光标处插入,或者替换选区。AI 提供商来自模块全局设置。
导入与导出
- Markdown(.md) —— 导出当前页面。
- HTML(.html) —— 含内联样式。
- ZIP(Markdown) —— 所有页面以
.md集合形式。 - ZIP(HTML) —— 所有页面以
.html集合形式。 - 导入
.md—— 从文件创建新页面。 - 发送至上下文 —— 页面内容可推送到 Context Manager & RAG 以便后续 AI 检索。
全局设置
在 设置 → 文档:
- 文档 AI 提供商(
docsAiProviderId)—— 来自 AI 聊天 注册表的提供商,用于 Summarize / Continue / Translate / Improve。
使用流程
1. 创建第一个页面
- 在左侧菜单打开 文档 模块。
- 在侧栏点击 + 新建页面。
- 输入标题(可选地选择图标)。
- 打开页面。
2. 撰写内容
- 输入文字;
/打开 slash 菜单。 - 直接将文件拖入编辑器以添加附件和图片。
- 使用
[[]]创建到其他页面的 wiki 链接。
3. 构建结构
- 在侧栏拖动页面以调整层级。
- 将常用页面标记为 收藏。
4. 使用 AI 助手
选中文字 → 工具栏中的 AI 按钮 → 选择操作。结果可插入或替换选区。
5. 回滚到某个版本
打开 版本历史 面板 → 选中快照 → 恢复。当前内容保存为新版本。
6. 导出
页面菜单 → 导出 → 选择格式。要导出整棵树,使用 导出 ZIP。
下一步
帮助与反馈
希望支持标签、协同编辑或更多导出格式?通过反馈表单联系我们。