Skip to content

Commit

Permalink
docs(formula): optimize mathlive formula docs (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
kagol authored Nov 11, 2024
1 parent 35e158f commit bd121de
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions packages/docs/fluent-editor/docs/formula.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
# 公式

在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'
import 'mathlive/static.css'
import 'mathlive/fonts.css'
```

### 模块配置
配置 `mathlive` 模块和工具栏:

```json
{
Expand All @@ -38,7 +37,5 @@ import 'mathlive/fonts.css'
}
```

开启mathlive公式后会覆盖quill原生的formula功能

:::demo src=demos/mathlive.vue
:::demo src=demos/formula-mathlive.vue
:::

0 comments on commit bd121de

Please sign in to comment.