diff --git a/docs/user/export.md b/docs/user/export.md index fa98184..50ba691 100644 --- a/docs/user/export.md +++ b/docs/user/export.md @@ -2,6 +2,57 @@ UAI Editor 提供了文档导出功能,包括导出成Word文档、ODT文档、Markdown文档等。这些功能都放置在“导出”选项卡下。 +**但是,由于项目中使用的导出DOCX,ODT, Markdown功能,依赖@tiptap-pro扩展,所以使用该扩展进行文档导出需要创建Conversion App ID和JSON Web Token (JWT)。** + +## 前置配置工作 + +### 注册Tiptap Cloud账号 + +通过[https://cloud.tiptap.dev/register](https://cloud.tiptap.dev/register)链接注册一个Tiptap Cloud账号。 + +![](images/development-01.png) + +验证注册的邮箱。 + +![](images/development-02.png) + +填写团队信息。 + +![](images/development-03.png) + +填写个人信息。 + +![](images/development-04.png) + +### 登录Tiptap Cloud账号 + +通过[https://cloud.tiptap.dev/login](https://cloud.tiptap.dev/login)链接登录已有账号。 + +![](images/development-05.png) + +### 获取Conversion App ID和JWT + +通过[https://cloud.tiptap.dev/v2/cloud/convert](https://cloud.tiptap.dev/v2/cloud/convert)链接,获取个人的Conversion App ID和JWT。 + +![](images/development-06.png) + +这里,Conversion App ID可以直接复制,而JWT则可以参考`documentation`文档生成,或者点击`Show example JWT`按钮获得一个临时JWT。 + +![](images/development-07.png) + +### 设置环境变量 + +由于项目中使用了环境变量进行配置,所以在获得Conversion App ID和JWT之后,需要在自己的电脑上设置环境变量:`TIPTAP_APP_ID`和`TIPTAP_JWT_TOKEN`。即: + +```bash +TIPTAP_APP_ID=${前面获取到的Conversion App ID} +TIPTAP_JWT_TOKEN=${前面获取到的JWT} +``` + +环境变量设置好以后,重启程序,就可以正常使用导出`DOCX`,`ODT`,`Markdown`功能了。 + +> **目前Tiptap-Pro扩展可以免费使用,缺点就是JWT有效期很短,需要经常更换,后续考虑抛弃Tiptap-Pro扩展,使用自定义的方法来进行导出。** + ## 导出Word文档 在工具栏点击导出Word文档按钮。 diff --git a/docs/user/images/development-01.png b/docs/user/images/development-01.png new file mode 100644 index 0000000..4f3a8e8 Binary files /dev/null and b/docs/user/images/development-01.png differ diff --git a/docs/user/images/development-02.png b/docs/user/images/development-02.png new file mode 100644 index 0000000..24747d2 Binary files /dev/null and b/docs/user/images/development-02.png differ diff --git a/docs/user/images/development-03.png b/docs/user/images/development-03.png new file mode 100644 index 0000000..e5d305c Binary files /dev/null and b/docs/user/images/development-03.png differ diff --git a/docs/user/images/development-04.png b/docs/user/images/development-04.png new file mode 100644 index 0000000..ae38a48 Binary files /dev/null and b/docs/user/images/development-04.png differ diff --git a/docs/user/images/development-05.png b/docs/user/images/development-05.png new file mode 100644 index 0000000..125c6d3 Binary files /dev/null and b/docs/user/images/development-05.png differ diff --git a/docs/user/images/development-06.png b/docs/user/images/development-06.png new file mode 100644 index 0000000..d7f7803 Binary files /dev/null and b/docs/user/images/development-06.png differ diff --git a/docs/user/images/development-07.png b/docs/user/images/development-07.png new file mode 100644 index 0000000..787f8f2 Binary files /dev/null and b/docs/user/images/development-07.png differ