4 个版本 (重大更改)
| 0.4.0 | 2024 年 3 月 22 日 |
|---|---|
| 0.3.0 | 2024 年 3 月 15 日 |
| 0.2.0 | 2024 年 1 月 1 日 |
| 0.1.0 | 2023 年 11 月 23 日 |
在 文本处理 中排名 1358
每月下载量 46 次
21KB
274 行
mdbook-numeq
一个 mdBook 预处理器，用于自动编号居中公式，并最终创建指向这些公式的链接，以获得类似 "LaTeX" 的体验。
安装
假设您已安装 mdBook 和 mdbook-katex，请使用以下命令安装 crate：
$ cargo install mdbook-numeq
然后将它添加到您的 book.toml 中的预处理器
[preprocessor.numeq]
此 crate 使用 htmlID 命令，该命令默认禁用。必须通过将 trust = true 添加到 mdbook-katex 预处理器的选项中来启用它
[preprocessor.katex]
trust = true
用法
只需在您的居中公式的末尾添加 {{numeq}}，例如（假设您已在 mdbook-katex 预处理器选项 中将居中公式的定界符设置为 \[ ... \]）
\[
a= b {{numeq}}
\]
您的公式将被自动编号
a = b (1)
您可以选择提供标签 {{numeq}}{mylabel}，在这种情况下将创建一个锚点。然后您可以使用 {{eqref: mylabel}} 链接到公式。
选项
默认情况下，编号是按（子）章节进行的，这意味着在每个（子）章节的开始时计数器重置为零。您可以通过将 global 选项设置为 true 来选择在整个书中使用全局编号
[preprocessor.numeq]
global = true
然后，公式将按顺序编号，例如，第 1 章为 1 到 5，第 2 章为 6 到 9，等等。
您可以选择通过将 prefix 选项设置为 true 来将章节号作为计数器的前缀（当 global 为 false 时，这样做更有意义，但这两个选项是独立的）。
[preprocessor.numeq]
prefix = true
例如，在章节 3.2 中，方程将被编号为 3.2.1，3.2.2 等等。
此外，depth 选项控制应该应用多少层前缀。如果不指定或将其设置为 depth = 0，则始终使用完整的前缀。例如，将其设置为 depth = 1，则整个章节 3 及其所有子章节中的方程将被编号为 3.1，3.2 等。请注意，前缀总是 depth 长度，并且如果需要则添加尾随零（例如，如果 depth = 3，则在章节 3 中使用前缀 3.0.0，在章节 3.1 中使用前缀 3.1.0 等）。
尽管在 prefix = true 时，使用严格大于 0 的 depth 才有意义，但这两个选项是独立的。请注意，当 depth 设置为任何严格大于 0 的数字时，选项 global 被忽略，并且方程计数器对每个前缀进行重置。这意味着设置
[preprocessor.numeq]
global = true
prefix = false
depth = 1
等同于
[preprocessor.numeq]
global = false
prefix = false
并且方程计数器在每个（子）章节上重置，不添加前缀。
依赖关系
~12–23MB
~325K SLoC