文档导入和导出
专业套餐
Conversion 是所有 Tiptap 订阅 中包含的专业套餐。 在安装之前,您需要先设置 访问 Tiptap 的私有 NPM 仓库。
Tiptap Conversion 在文档格式与编辑器的文档模型之间进行转换。它支持导入 DOCX 和 Markdown,并导出为 DOCX、PDF、ODT、EPUB 和 Markdown。它不是文档渲染器,不是实时协作编辑器(那是另一个独立的 Tiptap 产品),不是 OCR 或扫描 PDF 处理器,也不是异步任务队列——每个端点都会同步处理,并在响应中返回结果。它是一个桥梁。编辑器中呈现什么,取决于您安装了哪些扩展。
转换流程
Conversion 是一个多步骤流程,而不是单个操作。转换服务负责在文件格式和 Tiptap 的 JSON 文档模型之间进行转换。您的编辑器负责渲染。
- 导入: 转换服务解析您的源文档并生成 Tiptap JSON,这是对文档内容、格式和布局的结构化表示。
- 编辑器渲染: 您的 Tiptap 编辑器接收 JSON。对于 JSON 中的每一种节点类型(标题、表格、图片等),编辑器都需要安装匹配的扩展才能渲染它。没有匹配扩展的内容需要进行管理。有关策略,请参见无效 schema 指南。
- 导出: 导出扩展会将编辑器中的内容转换回文档格式。它导出的是编辑器当前包含的内容,而不是原始源文档中的内容。
请查看支持的功能页面,了解每个阶段哪些功能可用的完整说明,或浏览内容类型页面,查看按功能划分的详细文档。
在在线演示中亲自试试。
渲染转换后内容所需的内容
您在编辑器中重建多少文档体验,取决于您正在构建什么。
ConvertKit
对于任何 Conversion 工作流,都请注册来自 @tiptap-pro/extension-convert-kit 的 ConvertKit 扩展。ConvertKit 是 Conversion 的标准编辑器套件:它捆绑了一个支持 DOCX 的 schema(段落、标题、列表、图片、标记)以及转换服务生成的格式属性。请用它替代 StarterKit —— 即使您目前还不导入 DOCX,ConvertKit 也能让您为将来的导入做好准备。
如果您正在构建一个接受文档上传的内容编辑器或 CMS,这就足够了。文本内容会在连续滚动编辑器中正确渲染。对于 Markdown 导入,ConvertKit 也是正确的选择——它覆盖了同样的一组功能。
支持的功能页面展示了 ConvertKit 对每个功能的处理情况,以及您可能需要额外扩展的地方。
用于文档布局的 Pages 扩展
对于具备页眉、页脚、分页、页码、页面大小和页边距的分页感知型文档,您还需要 Pages 扩展 和 PagesTableKit。Pages 提供分页式编辑体验,内容会在可视页面之间流动,页眉和页脚拥有专用的编辑区域;PagesTableKit 提供支持分页安全的表格(ConvertKit 内置表格不会分页)。
分页感知型导入——页眉、页脚、分页——只有在安装 Pages 后才能在编辑器中渲染。没有 Pages 时,导入的页眉和页脚没有地方渲染,分页会被忽略,也没有页面边界的概念。
| 您正在构建的内容 | 您需要的内容 |
|---|---|
| 带文档上传的内容编辑器或 CMS | ConvertKit |
| 带页面布局的文档编辑器 | ConvertKit + TableKit (@tiptap-pro/extension-pages-tablekit) + Pages(并使用 ConvertKit.configure({ table: false })) |
| 无头流程(没有编辑器) | 仅 REST API,不需要扩展 |
支持的格式
您可以通过编辑器扩展(Tiptap 编辑器中的命令)或 REST API(用于服务器端或非编辑器场景的 HTTP 端点)来集成转换。
| 格式 | 导入 | 导出 | 备注 |
|---|---|---|---|
| DOCX (Word) | 扩展, REST API | 扩展, REST API | |
| Markdown | REST API | 扩展, REST API | |
| 扩展, REST API | |||
| ODT | 扩展, REST API | ||
| EPUB | 扩展, REST API | ||
| DOC (旧版) | 扩展, REST API |
Markdown 也可以作为核心编辑器功能使用,具备内置解析和序列化功能,与转换服务无关。
下一步
旧版导入/导出扩展
旧版 @tiptap-pro/extension-import 和 @tiptap-pro/extension-export 包正在被弃用,并将于 2026 年停止服务。这些扩展不会获得新功能,仅维护现有用户。
迁移到新扩展: 当前的 Import DOCX 和 Export DOCX 扩展提供了更好的转换质量、更多格式选项以及持续开发。我们建议尽快迁移。