Lib.rs

将KaTeX自动渲染脚本插入rustdoc

使用方法

#[cfg_attr(doc, katexit::katexit)]
/// We can write $\LaTeX$ expressions
///
/// Display style
/// -------------
///
/// $$
/// c = \\pm\\sqrt{a^2 + b^2}
/// $$
pub fn my_func() {}

在docs.rs上查看渲染结果。

工作原理

#[katexit]过程宏插入KaTeX自动渲染脚本作为#[doc = "{script}"]。由于rustdoc的Markdown到HTML翻译器不会触及嵌入在Markdown中的HTML部分，因此它们将原样传递给浏览器。自动渲染脚本将在打开由rustdoc生成的页面时开始渲染文档部分中用$写成的数学表达式，即这不在离线状态下工作。

链接

• rustdoc-katex-demo和类似的演示项目
  • 它们使用--html-in-header选项在rustdoc中插入KaTeX自动渲染脚本。但需要在Cargo.toml中进行一些复杂的设置。
• aquamarine
  • 使用过程宏为cargo-doc的想法基于这个crate。
• katex-rs
  • 这是“KaTeX的Rust绑定”。这个crate的目标是在不依赖外部依赖的情况下使用QuickJS运行KaTeX。