Lib.rs

mdbook-katex2 旨在成为 mdbook-katex 的维护版本，提供等效功能。

mdbook-katex 是一个 mdBook 预处理器，在构建时将LaTeX方程预渲染为HTML。与在浏览器中渲染方程相比，它可以实现非常快的页面加载。

此预处理器使用 katex crate；有关支持的LaTeX函数列表，请参阅此页面。

入门指南

首先，安装 mdbook-katex2

cargo install mdbook-katex2

然后，将以下行添加到您的 book.toml 文件中

[output.katex2]

[preprocessor.katex2]

现在，您可以在 .md 文件中使用 $ 和 $$ 分隔符来设置行内和显示方程。如果您需要一个普通的美元符号，可以使用反斜杠 \$ 转义分隔符。

# Chapter 1

Here is an inline example, $ \pi(\theta) $, 

an equation,

$$ \nabla f(x) \in \mathbb{R}^n, $$

and a regular \$ symbol.

LaTeX方程将在运行 mdbook build 或 mdbook serve 时作为HTML渲染。

来自 mdbook-katex

在使用预处理器方面，除了在 入门指南 中指定的 katex 后添加一个 2 以外，没有差异。

Katex选项

预处理器支持向 katex-rs crate 传递选项以配置其行为。这些选项在 [preprocessor.katex2] 指令下指定。

当前支持的参数如下

还有配置预处理器行为的选项

自定义宏

自定义LaTeX宏必须在按照以下模式定义的 .txt 文件中。

\grad:{\nabla}
\R:{\mathbb{R}^{#1 \times #2}}

您需要在您的 book.toml 中指定此文件的路径，如下所示：

[preprocessor.katex2]
macros = "path/to/macros.txt"

然后可以在您的 .md 文件中使用这些宏。

# Chapter 1

$$ \grad f(x) \in \R{n}{p} $$

注意事项：

书的构建工件将位于您指定的目录中的 html 文件夹中，而不是直接放置在那里。这与 mdbook_katex 的行为相同。当您在您的持续集成 (CI) 中使用 mdbook_katex2 时，请考虑这一点。

$\backslash$ 不起作用，但您可以使用 $\setminus$ 代替。

致谢：

mdbook-katex 由 Lucas Zanini 等人开发，有关所有个人贡献，请参阅原始存储库。