--- title: "@mdit/plugin-katex" shortTitle: "plugin-katex" icon: square-root-variable --- 使用 KaTeX 呈现数学表达式的插件。 ::: note 这个插件基于 [@mdit/plugin-tex](tex.md)。 ::: ## 使用 ```ts import { katex } from "@mdit/plugin-katex"; import MarkdownIt from "markdown-it"; const mdIt = new MarkdownIt().use(katex); mdIt.render("$E=mc^2$"); ``` 我们也有一个 `@mdit/plugin-katex-slim` 包,其中 `katex` 是可选对等依赖。 ## 语法 语法取决于 `delimiters` 选项: - **默认 (`"dollars"`)**: 内联使用 `$tex expression$`,块级使用 `$$tex expression$$`。 - **LaTeX 风格 (`"brackets"`)**: 内联使用 `\(tex expression\)`,块级使用 `\[tex expression\]`。 - **两种语法 (`"all"`)**: 同时支持美元符号和括号语法。 ::: tip 样式 你应该自己从 `katex` 包或 CDN 导入 `katex/dist/katex.min.css`。 ::: ::: tip 转义 - 你可以使用 `\` 来转义 `$` `\[` 和 `\(`: ```md Euler’s identity \$e^{i\pi}+1=0$ ``` 会被渲染为 Euler’s identity \$e^{i\pi}+1=0$ ::: ## 选项 此插件扩展了 KaTeX 选项。可用选项包括: ::: fields @`logger` type=KatexLogger ```ts type KatexLogger = ( errorCode: | "unknownSymbol" | "unicodeTextInMathMode" | "mathVsTextUnits" | "commentAtEnd" | "htmlExtension" | "newLineInDisplayMode", errorMsg: string, token: Token | undefined, env: MarkdownItEnv, ) => "error" | "warn" | "ignore" | boolean | undefined; ``` 错误日志记录器函数。 @`transformer` type=`(content: string, displayMode: boolean) => string` 输出内容的转换器函数。 ::: ::: tip 错误处理 `throwOnError` 会透传给 KaTeX,默认值为 `false`,因此无效公式会渲染为错误文本。如果你希望无效公式直接抛出 KaTeX 的 `ParseError`(例如让构建失败),请将其设为 `true`。 ::: ## 示例 ::: preview 示例 Euler’s identity $e^{i\pi}+1=0$ is a beautiful formula in $\mathbb{R}^2$. $$ \frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right) = \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^i r \cdots (r-i+1) (\log y)^{r-i}} {\omega^i} \right\} $$ ::: ## mhchem 扩展 如果你想加载 `mhchem` 扩展,你应该导入 `@mdit/plugin-katex/mhchem`: ```ts import { katex } from "@mdit/plugin-katex"; import "@mdit/plugin-katex/mhchem"; ``` ## 支持列表 - [KaTeX 支持功能](https://katex.org/docs/supported.html) - [KaTeX 支持列表](https://katex.org/docs/support_table.html) ## Cookbook - [$\TeX$ Cookbook](tex.md#tex-教程) --- > 与上游参考实现的完整对比见[对比报告](compare.md)。