@mdit/plugin-mathjax

使用 Mathjax 呈现数学表达式的插件。

注

使用没有 CDN 脚本

import { createMathjaxInstance, mathjax } from "@mdit/plugin-mathjax";
import MarkdownIt from "markdown-it";

const mathjaxInstance = await createMathjaxInstance(options);
const mdIt = new MarkdownIt().use(mathjax, mathjaxInstance);

const html = mdIt.render("$E=mc^2$");
const style = await mathjaxInstance.outputStyle();

这个插件与其他插件有点不同。它要求你先创建通过选项一个 Mathjax 实例，然后将其传递给插件。接受的选项见选项，实例暴露的成员见实例。

我们也有一个 @mdit/plugin-mathjax-slim 包，其中 @mathjax/src 和 @mathjax/mathjax-newcm-font 是可选对等依赖。

为了更好的性能与内存，createMathjaxInstance 函数是异步的，允许仅动态加载你需要的 $T e X$ 包，但是如果你必须在一个同步流程中调用插件，你可以从 @mdit/plugin-mathjax/sync 导入 createMathjaxInstance 函数的同步版本。

格式

语法取决于 delimiters 选项：

默认 ("dollars"): 内联使用 $tex expression$ ，块级使用 $$tex expression$$。
LaTeX 风格 ("brackets"): 内联使用 $tex expression$，块级使用 \[tex expression\]。
两种语法 ("all"): 同时支持美元符号和括号语法。

转义

你可以使用 \ 来转义 $ \[ 和 \(:
```
Euler’s identity \$e^{i\pi}+1=0$
```
会被渲染为
Euler’s identity $e^{i\pi}+1=0$

选项

createMathjaxInstance(options) 支持以下选项：

output"chtml" | "svg"

默认值"svg"

输出格式。

delimiters"brackets" | "dollars" | "all"

默认值"dollars"

启用的数学分隔符语法。

"brackets": 使用 $...$ 表示内联数学，使用 \[...\] 表示显示模式数学（LaTeX 风格）。
"dollars": 使用 $...$ 表示内联数学，使用 $$...$$ 表示显示模式数学（常见 Markdown 风格）。
"all": 启用括号和美元符号两种语法。

allowInlineWithSpaceboolean

默认值false

是否允许两端带空格的内联数学。

不建议将此设置为 true，因为它很可能会破坏 $ 的默认使用。

mathFenceboolean

默认值false

是否将解析的数学语言 fence 块转换为显示模式数学。

boolean

默认值true

是否启用无障碍。

texMathJaxTexInputOptions

TeX 输入选项。

chtmlMathjaxCommonHTMLOutputOptions

通用 HTML 输出选项。

svgMathjaxSVGOutputOptions

SVG 输出选项。

transformerTeXTransformer

输出内容的转换器。

debugboolean

默认值false

启用调试模式。

实例

createMathjaxInstance(options) 会 resolve 出你传给插件的实例。除了解析后的选项外，实例还暴露以下方法：

outputStyle() => Promise<string>

返回汇总所有已渲染公式的 CSS 内容。

生成样式表前会按需加载字体文件，并会在返回后清空样式缓存，因此请在全部渲染完成后再调用。使用来自 @mdit/plugin-mathjax/sync 的同步版 createMathjaxInstance 时，返回类型为 string 而非 Promise<string>。

reset() => void

重置 $T e X$ 输入，清除用户定义的宏、环境与标签。

插件会在每次渲染后自动调用它，避免状态跨文档泄漏。如需在所有文档中持续使用某个宏，请改用 tex.macros 选项定义。

clearStyle() => void

清除样式缓存并重置输入与输出 jax。输出 jax 尚未初始化时不会做任何事。

示例

Euler’s identity $e^{i π} + 1 = 0$ is a beautiful formula in $R^{2}$ .

\frac{\partial^{r}}{\partial ω^{r}} (\frac{y^{ω}}{ω}) = (\frac{y^{ω}}{ω}) {(\log y)^{r} + \sum_{i = 1}^{r} \frac{(- 1)^{i} r \dots (r - i + 1) (\log y)^{r - i}}{ω^{i}}}

示例

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\}
$$