Tiptap 中文文档

安装

Available in Start planBeta

为你的项目设置凭据并安装转换扩展。

前置条件

  1. 开始 免费试用或选择订阅。
  2. 设置对 Tiptap 私有 npm 仓库 的访问权限。

身份验证

大多数转换扩展和 REST API 端点都需要 JWT 进行身份验证。DOCX 导出扩展是个例外，它无需凭据即可工作。

  1. 前往你的 Tiptap Cloud 账户中的 转换设置 页面。
  2. 复制你的 App ID 和 secret key。
  3. 使用任意 JWT 工具（例如 JWT Builder）生成 JWT 以用于本地测试。在生产环境中，请始终在服务端生成 JWT，以确保密钥安全。

在配置扩展或发起 REST API 调用时，你需要传入 JWT 和 App ID。有关详情，请参阅下方按格式划分的设置指南。

安装包

安装你需要支持的格式所对应的扩展。

导入：

# DOCX 导入（编辑器扩展）
npm install @tiptap-pro/extension-import-docx

导出：

# DOCX 导出（编辑器扩展，无需身份验证）
npm install @tiptap-pro/extension-export-docx

# PDF 导出
npm install @tiptap-pro/extension-export-pdf

# ODT 导出
npm install @tiptap-pro/extension-export-odt

# EPUB 导出
npm install @tiptap-pro/extension-export-epub

# Markdown 导出
npm install @tiptap-pro/extension-export-markdown

DOCX 导出不需要身份验证

@tiptap-pro/extension-export-docx 包完全在客户端处理转换。无需 JWT、 App ID 或服务器调用。

下一步

在侧边栏中选择你的格式，查看每个扩展和 REST API 的完整设置与配置指南。

Previously概述