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

本贴最后更新于 417 天前,其中的信息可能已经水流花落

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

image.png

在 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}
\left(\frac{2}{3}\right)
  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    26093 引用 • 108342 回帖
  • KaTex
    3 引用 • 11 回帖
1 操作
Frostime 在 2024-05-06 11:18:03 更新了该帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • React

    React 是 Facebook 开源的一个用于构建 UI 的 JavaScript 库。

    192 引用 • 291 回帖 • 367 关注
  • SEO

    发布对别人有帮助的原创内容是最好的 SEO 方式。

    36 引用 • 200 回帖 • 34 关注
  • NGINX

    NGINX 是一个高性能的 HTTP 和反向代理服务器,也是一个 IMAP/POP3/SMTP 代理服务器。 NGINX 是由 Igor Sysoev 为俄罗斯访问量第二的 Rambler.ru 站点开发的,第一个公开版本 0.1.0 发布于 2004 年 10 月 4 日。

    315 引用 • 547 回帖
  • OneDrive
    2 引用 • 4 关注
  • 分享

    有什么新发现就分享给大家吧!

    248 引用 • 1794 回帖 • 1 关注
  • 设计模式

    设计模式(Design pattern)代表了最佳的实践,通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。这些解决方案是众多软件开发人员经过相当长的一段时间的试验和错误总结出来的。

    201 引用 • 120 回帖
  • Node.js

    Node.js 是一个基于 Chrome JavaScript 运行时建立的平台, 用于方便地搭建响应速度快、易于扩展的网络应用。Node.js 使用事件驱动, 非阻塞 I/O 模型而得以轻量和高效。

    139 引用 • 269 回帖
  • Swift

    Swift 是苹果于 2014 年 WWDC(苹果开发者大会)发布的开发语言,可与 Objective-C 共同运行于 Mac OS 和 iOS 平台,用于搭建基于苹果平台的应用程序。

    34 引用 • 37 回帖 • 554 关注
  • Shell

    Shell 脚本与 Windows/Dos 下的批处理相似,也就是用各类命令预先放入到一个文件中,方便一次性执行的一个程序文件,主要是方便管理员进行设置或者管理用的。但是它比 Windows 下的批处理更强大,比用其他编程程序编辑的程序效率更高,因为它使用了 Linux/Unix 下的命令。

    125 引用 • 74 回帖
  • 代码片段

    代码片段分为 CSS 与 JS 两种代码,添加在 [设置 - 外观 - 代码片段] 中,这些代码会在思源笔记加载时自动执行,用于改善笔记的样式或功能。

    用户在该标签下分享代码片段时需在帖子标题前添加 [css] [js] 用于区分代码片段类型。

    191 引用 • 1359 回帖
  • 面试

    面试造航母,上班拧螺丝。多面试,少加班。

    326 引用 • 1395 回帖
  • Jenkins

    Jenkins 是一套开源的持续集成工具。它提供了非常丰富的插件,让构建、部署、自动化集成项目变得简单易用。

    54 引用 • 37 回帖
  • LeetCode

    LeetCode(力扣)是一个全球极客挚爱的高质量技术成长平台,想要学习和提升专业能力从这里开始,充足技术干货等你来啃,轻松拿下 Dream Offer!

    209 引用 • 72 回帖
  • Elasticsearch

    Elasticsearch 是一个基于 Lucene 的搜索服务器。它提供了一个分布式多用户能力的全文搜索引擎,基于 RESTful 接口。Elasticsearch 是用 Java 开发的,并作为 Apache 许可条款下的开放源码发布,是当前流行的企业级搜索引擎。设计用于云计算中,能够达到实时搜索,稳定,可靠,快速,安装使用方便。

    117 引用 • 99 回帖 • 196 关注
  • Ruby

    Ruby 是一种开源的面向对象程序设计的服务器端脚本语言,在 20 世纪 90 年代中期由日本的松本行弘(まつもとゆきひろ/Yukihiro Matsumoto)设计并开发。在 Ruby 社区,松本也被称为马茨(Matz)。

    7 引用 • 31 回帖 • 261 关注
  • Excel
    31 引用 • 28 回帖
  • Gzip

    gzip (GNU zip)是 GNU 自由软件的文件压缩程序。我们在 Linux 中经常会用到后缀为 .gz 的文件,它们就是 Gzip 格式的。现今已经成为互联网上使用非常普遍的一种数据压缩格式,或者说一种文件格式。

    9 引用 • 12 回帖 • 178 关注
  • 浅吟主题

    Jeffrey Chen 制作的思源笔记主题,项目仓库:https://github.com/TCOTC/Whisper

    1 引用 • 28 回帖 • 1 关注
  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发,最早发布于 2014 年 9 月。

    59 引用 • 22 回帖 • 11 关注
  • JVM

    JVM(Java Virtual Machine)Java 虚拟机是一个微型操作系统,有自己的硬件构架体系,还有相应的指令系统。能够识别 Java 独特的 .class 文件(字节码),能够将这些文件中的信息读取出来,使得 Java 程序只需要生成 Java 虚拟机上的字节码后就能在不同操作系统平台上进行运行。

    180 引用 • 120 回帖 • 2 关注
  • Outlook
    1 引用 • 5 回帖 • 3 关注
  • Android

    Android 是一种以 Linux 为基础的开放源码操作系统,主要使用于便携设备。2005 年由 Google 收购注资,并拉拢多家制造商组成开放手机联盟开发改良,逐渐扩展到到平板电脑及其他领域上。

    336 引用 • 324 回帖
  • Ubuntu

    Ubuntu(友帮拓、优般图、乌班图)是一个以桌面应用为主的 Linux 操作系统,其名称来自非洲南部祖鲁语或豪萨语的“ubuntu”一词,意思是“人性”、“我的存在是因为大家的存在”,是非洲传统的一种价值观,类似华人社会的“仁爱”思想。Ubuntu 的目标在于为一般用户提供一个最新的、同时又相当稳定的主要由自由软件构建而成的操作系统。

    127 引用 • 169 回帖
  • Hadoop

    Hadoop 是由 Apache 基金会所开发的一个分布式系统基础架构。用户可以在不了解分布式底层细节的情况下,开发分布式程序。充分利用集群的威力进行高速运算和存储。

    93 引用 • 122 回帖 • 618 关注
  • WebClipper

    Web Clipper 是一款浏览器剪藏扩展,它可以帮助你把网页内容剪藏到本地。

    3 引用 • 9 回帖
  • RemNote
    2 引用 • 16 回帖 • 25 关注
  • Firefox

    Mozilla Firefox 中文俗称“火狐”(正式缩写为 Fx 或 fx,非正式缩写为 FF),是一个开源的网页浏览器,使用 Gecko 排版引擎,支持多种操作系统,如 Windows、OSX 及 Linux 等。

    7 引用 • 30 回帖 • 380 关注