快速开始

本页给出最短路径：开启协作 → 开启版本功能 → 创建版本 → 预览/对比 → 回溯恢复。

1. 开启协作与服务端

历史版本功能依赖多人协作能力。

• 服务端：部署并启动 Umo Editor Server，见 Umo Editor Server。
• 客户端：开启协作配置，见 多人协作编辑。

2. 启用 versions 配置

const options = {
  collaboration: {
    enabled: true,
    // ...
  },
  versions: {
    enabled: true,
  },
}

3. 打开历史版本面板

在编辑器界面中，打开“历史版本”面板（入口通常位于工具栏或“开始”菜单中）。

历史版本面板里常见的区域包括：

• 版本列表：展示所有已保存版本
• 操作区：创建版本、进入对比、执行恢复等

4. 创建版本

在历史版本面板中点击“创建版本/保存版本”，输入版本名称后保存即可。

建议版本名称采用“阶段 + 日期时间”的格式，便于团队理解与检索，例如：阶段验收 02-15 10:30。

5. 预览与对比

在历史版本面板中点击某个版本：进入预览（以 diff 的形式显示该版本与前一个版本的差异）,只有一个版本时，则仅显示该版本内容，不显示对比结果。

如果你的文档开启了评论/批注，对比时可以通过配置忽略这些非正文差异（见 配置项）。

const options = {
  versions: {
    enabled: true,
    diffIgnoreMarks: ['inlineThread'],
    diffIgnoreAttributes: ['id', 'data-thread-id'],
  },
}

6. 回溯恢复

在历史版本面板中选择目标版本，点击“还原”即可。

恢复成功后：

• 当前文档内容会切换到目标版本内容
• 该变化会同步给协作者
• 版本列表会新增两条记录：恢复前备份与恢复后记录（便于追溯与撤销）

7. 标记重要版本

在历史版本列表中，对目标版本点击“更多”按钮：

• 选择“标为重要”：该版本会显示“重要”标签
• 再次选择“取消重要”：移除“重要”标签

适合将“阶段验收/发布节点/对外共享前”等关键版本标记出来，方便团队快速定位。