F 的分享 | 如何在思源中使用 KaTex 宏

思源笔记当中「设置」-「编辑器」中有一个「Katex 宏定义」的设置选项，长久以来一直被人忽略，甚至连官方文档里面都没有提到他——但实际上这个东西非常有用。

在 KaTeX 中，「宏」允许你将一个长且复杂的表达式缩写成一个简短的标识符。

他实际上就是一种字符串替换规则：首先定义一个简短的字符串（宏名），并告诉 KaTeX 当你写下这个宏名时，应该用哪个更长的字符串（通常是一个数学表达式）来替换它。

这样一来，在编写数学公式时，只需输入宏名，KaTeX 就会自动将其替换为对应的完整表达式。这使得重复输入复杂表达式变得快速且不易出错。

定义宏首先要指定一个用 \ 开头的文本，比如 \foo；然后，指定一个字符串来描述这个宏应该展开成什么，就像在一个字典或者映射表中一样。在实际使用的时候，KaTex 引擎就会用后面的替代文本来替代前面的键。

思源中支持用 Json 格式来声明宏定义，其中的键是宏的名称，值是宏的替代文本。例如下面这个例子中，当你在 KaTeX 中使用 \foo 时，它会被替换为 {x^2}。

{
  "\\foo": "{x^2}"
}
​

注：之所以这里用 \\foo 而不是 \foo 是因为程序处理 json 的时候，需要转义 \ 字符。

更加复杂的案例

这里给一个更复杂一些的案例：

{
  "\\aligned": "\\begin{aligned}#1\\end{aligned}",
}
​

有了这个宏只需写 \aligned{...}，并把方程组作为参数放在大括号中，就能定义一个 aligned 环境。

我们可以使用刚刚定义的 \aligned 宏来整洁地表示一个复数的极坐标和直角坐标之间的转换。

\aligned{
&z = (real, imag) = (M, \theta)\\
& M = \sqrt{real^2 + imag^2}\\
&\theta = \arctan{\left(\frac{imag}{real}\right)}\\
& real = M\cos{\theta}\\
& imag = M\sin{\theta}
}
​

以上代码就会被展开为:

\begin{aligned}
&z = (real, imag) = (M, \theta)\\
& M = \sqrt{real^2 + imag^2}\\
&\theta = \arctan{\left(\frac{imag}{real}\right)}\\
& real = M\cos{\theta}\\
& imag = M\sin{\theta}
\end{aligned}
​

宏参数

上面的案例用到了宏参数，它用 # 后跟一个数字表示，例如 #1，#2 等。这些数字指的是宏使用时相应位置的参数。

例如，如果定义了一个宏 \foo 来表示某个带有一个参数的数学操作，就像这样：

{
  "\\foo": "f(#1)"
}
​

在这里，#1 将会被替换为在使用宏时提供的第一个参数。当你在数学表达式中写下 \foo{x} 时，KaTeX 会将其展开为 f(x)。

如果定义的宏需要多个参数，你可以在定义中包含 #1，#2，#3 等，以此类推，对应使用时的第一、第二、第三个括号里面的内容。

举一个多参数宏的例子：

{
  "\\binomial": "\\left(\\frac{#1}{#2}\\right)"
}
​

在这个宏定义中，\binomial 用来创建一个二项式系数。使用 \binomial{n}{k} 时，#1 会被替换为 n，而 #2 会被替换为 k，所以它会展开为 \left(\frac{n}{k}\right)。

\binomial{2}{3}
​