完善文档

This commit is contained in:
wux_labs
2025-05-27 12:12:56 +08:00
parent 3eb217dd4e
commit ed14ab616a
8 changed files with 51 additions and 0 deletions

View File

@@ -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文档按钮。

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 276 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 307 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 271 KiB