使用 Tiptap 管理文档
协作文档是 Tiptap 协作的核心，使用 Yjs 格式存储从内容和评论到版本和元数据的所有信息。
通常，用户通过 REST API 管理这些文档，或通过协作 Webhook 跟踪更改，该 Webhook 会发送详细的更新。Tiptap 会将文档转换为 HTML 或 JSON 格式，因此您无需直接处理 Yjs 格式。
- 托管您的文档： 选择云、专用云或本地部署。
- 文档 REST API： 以编程方式创建、更新和删除文档。
- Webhooks： 自动响应实时文档和评论事件。
- 文档版本管理与比较： 通过自动或手动版本控制跟踪文档中的更改，直观地比较快照之间的差异。
- 内容注入： 通过 REST API 在服务器端修改文档内容，即使在活跃的协作会话期间也可以进行修改。
企业本地解决方案
将协作及所有其他 Tiptap 特性集成到您的基础设施中。
- 本地部署：
在您的堆栈中部署我们的 Docker 镜像
- 高可用集群：
自信扩展到数百万用户
- 专用支持：
聊天中的自定义开发和集成支持
集成文档
将文档集成到您的编辑器和应用程序中是非常简单的。通过将 Tiptap 协作提供程序添加到您的设置，文档会自动存储和管理在 Tiptap 协作框架内。
此集成立即启用您使用所有文档功能，例如存储协作文档、管理版本历史、使用 REST API 和注入内容。
注意
您可以轻松地将文档从我们的云迁移到本地服务器。
- 集成 Tiptap 编辑器： 按照 安装指南 设置编辑器。
- 激活计划： 开始 免费试用或选择订阅。
- 添加环境： 在您的 仪表板，点击“添加环境”按钮，输入名称并选择离您的用户最近的区域。
- 检查配置： 保存环境后，您的应用程序会启动。访问 配置页面 以复制您的 AppID、API 密钥和其他连接详细信息。
现在，您已准备好使用文档功能。
检索和管理文档
使用 REST API 以 JSON 或 HTML 格式获取文档，便于与您的系统集成。要获取更改的即时更新，请配置 webhooks 以接收实时通知。
跟踪文档中的更改： Tiptap 协作中的 快照 扩展会自动捕捉并存储文档在指定间隔的快照。它还允许手动版本控制，使用户能够跟踪详细的更改和文档演变。
比较快照： 比较快照 扩展让您可以直观地比较文档的两个版本，突出显示更改及其作者，帮助您查看随时间而来的修改。
注入内容： 使用 Patch Document endpoint 更新活动文档的内容，允许即使在用户协作期间也进行服务器端修改。