From bd121de3e6d35291a1c101524546a2b4efbf1441 Mon Sep 17 00:00:00 2001
From: Kagol <kagol@sina.com>
Date: Mon, 11 Nov 2024 15:50:36 +0800
Subject: [PATCH] docs(formula): optimize mathlive formula docs (#119)

---
 .../{mathlive.vue => formula-mathlive.vue}    |  0
 packages/docs/fluent-editor/docs/formula.md   | 21 ++++++++-----------
 2 files changed, 9 insertions(+), 12 deletions(-)
 rename packages/docs/fluent-editor/demos/{mathlive.vue => formula-mathlive.vue} (100%)

diff --git a/packages/docs/fluent-editor/demos/mathlive.vue b/packages/docs/fluent-editor/demos/formula-mathlive.vue
similarity index 100%
rename from packages/docs/fluent-editor/demos/mathlive.vue
rename to packages/docs/fluent-editor/demos/formula-mathlive.vue
diff --git a/packages/docs/fluent-editor/docs/formula.md b/packages/docs/fluent-editor/docs/formula.md
index 44b7136..eef2443 100644
--- a/packages/docs/fluent-editor/docs/formula.md
+++ b/packages/docs/fluent-editor/docs/formula.md
@@ -1,24 +1,23 @@
 # 公式
 
-在Fluent Editor中处理公式有两种方法
-
-# quill原生公式（KaTeX）
+## 基本用法
 
 通过配置工具栏按钮 `formula`，可以开启插入公式功能。
 
-由于插入公式依赖 `KaTeX`，需要安装 `katex` 依赖包，并引入对应的样式。
+默认公式功能是 Quill 内置的，依赖 `KaTeX`，需要安装 `katex` 依赖包，并引入对应的样式。
 
 测试公式内容：e=mc^2
 
 :::demo src=demos/formula.vue
 :::
 
-# mathlive公式（LaTeX）
+## 可编辑公式
+
+默认的公式不可编辑，可以通过配置 `mathlive` 模块为 true，开启可编辑公式，可编辑公式基于 `mathlive`，公式格式为 `LaTeX`，开启 `mathlive` 公式后会覆盖 Quill 内置的 formula 功能。
 
-通过配置工具栏按钮 formula，可以开启插入公式功能。
-mathlive公式的格式为`LaTeX`。`mathlive`需要用户自行安装，安装后使用下面代码导入模块，并配置模块开启
+`mathlive` 需要用户自行安装，安装后使用下面代码导入模块，并配置模块开启。
 
-### 导入模块
+导入 `mathlive` 模块和样式：
 
 ```javascript
 import 'mathlive'
@@ -26,7 +25,7 @@ import 'mathlive/static.css'
 import 'mathlive/fonts.css'
 ```
 
-### 模块配置
+配置 `mathlive` 模块和工具栏：
 
 ```json
 {
@@ -38,7 +37,5 @@ import 'mathlive/fonts.css'
 }
 ```
 
-开启mathlive公式后会覆盖quill原生的formula功能
-
-:::demo src=demos/mathlive.vue
+:::demo src=demos/formula-mathlive.vue
 :::