pandoc-katex

一个 pandoc 过滤器，用于使用 KaTeX 渲染数学公式。它由 katex Rust 包 驱动。

安装

cargo install pandoc-katex

从源代码构建时，需要以下依赖项

• gcc 和 patch（适用于 Linux、macOS 和 MinGW/MSYS2）。
• msvc（适用于 Windows）。

或者，您可以从 发行版 下载预构建的二进制文件。

用法

pandoc -t html --filter pandoc-katex \
  --css "http://cdn.jsdelivr.net.cn/npm/katex@$(pandoc-katex --katex-version)/dist/katex.min.css" \
  --css "https://pandoc.org/demo/pandoc.css" \
  --standalone -o output.html /path/to/input.md

您还可以传递其他标志来自定义 KaTeX 渲染。例如，要使用自定义 LaTeX 宏

pandoc -t json /path/to/input.md | \
  pandoc-katex --macro '\RR:\mathbb{R}' | \
  pandoc -f json -t html \
    --css "http://cdn.jsdelivr.net.cn/npm/katex@$(pandoc-katex --katex-version)/dist/katex.min.css" \
    --css "https://pandoc.org/demo/pandoc.css" \
    --standalone -o output.html

有关更多信息，请参阅 pandoc-katex --help。

配置文件

选项还可以从外部配置文件中读取。配置文件应采用 .toml 格式。例如

fleqn = true

[macros]
"\\RR" = "\\mathbb{R}"

配置文件路径可以是命令行参数 --config-file /path/to/config.toml，或通过环境变量 PANDOC_KATEX_CONFIG_FILE 设置。

配置文件接受以下选项。请参阅 https://katex.org/docs/options.html 以获取更多信息。

许可