向 Rust 文档添加数学，例如 docs.rs

此仓库展示了如何向 https://docs.rs 添加 LaTeX 数学；数学由 katex 渲染。

工作原理

它将一段 HTML 嵌入 Rust 文档中，其中包含一个渲染 LaTeX 数学的 JavaScript 片段。

使用方法

• 本地构建带数学的文档： make 或： RUSTDOCFLAGS="--html-in-header katex.html" cargo doc --no-deps

• 为 docs.rs 构建带数学的文档，请在 Cargo.toml 中添加以下行

  [package.metadata.docs.rs]
  rustdoc-args = [ "--html-in-header", "katex.html" ]
  

渲染选项

此仓库提供两个渲染片段

• katex.html 将 $`i+1`$ 渲染为行内数学，以及数学代码块等渲染为数学块

  ```math
  i+1
  ```
  

• katex-dollar.html 将 $i+1$ 渲染为行内数学，以及 $$i+1$$ 渲染为块数学。

这两个文件的大小约为 257 KB。非压缩版本为 *-src.html。