1. 开始之前
如果你需要本教程的 Markdown 版本,请点击此链接
设置面板的使用
(1) 如何使用设置面板
我们有 3 种视图模式以供更好的布局安排:
- 简洁模式(默认):在
基础部分显示常用设置,其他较少使用的设置位于高级选项卡中。你还可以在自定义显示设置中配置要显示哪些设置。 - 分类模式(推荐/专业选项):以不同类别显示所有设置,如果你想查找特定类型的设置,这可能是最清晰的视图。
- 列表模式:此视图允许你搜索设置。
重要:在简洁模式下你不会看到所有设置,你需要在"自定义显示区域"中启用它们,或者切换到"分类模式"或列表模式才能找到所有设置。
如果你想创建一个与添加新设置相关的 issue,请先检查分类视图并在列表部分搜索,看看该设置是否已经存在。
(2) 隐藏设置
在 分类 > 公式面板 > 在公式面板中使用快速数学渲染器 中有一个快速数学渲染器选项。我强烈建议开启此选项,因为它能大幅提升公式面板的加载速度。唯一不可避免的 bug 是符号可能加载不完全,但只需简单滚动/跳转即可轻松解决。
语法规则
你需要遵循一些简单的规则以确保本插件正常工作。
(1) 代码块格式
- 代码块:始终使用 3 个反引号作为代码块格式,如下所示(4 和 5 个反引号也支持,但不推荐。6 个反引号可能导致代码块识别错误,因为一行中的 6 个反引号既可以形成行内代码也可以形成代码块)。
代码块
(2) 引用清晰性
- 避免在标签或引用中使用
\}(这会导致标签识别错误)。 - 使用数字(1, 2, 3, …)作为脚注编号,不要使用字符。
- 对于标注(callout),每一行都应以大于号
>开头。没有>符号的隐式标注行将被忽略。
(3) 编写公式块
我们的自动编号算法假定每个公式块都以 $$ 在新行开始,并且公式块的结束行以 $$ 结尾。这能提高笔记的解析速度。
✅ 正确示例:
%单行公式块格式%
$$ \Large \boxed{dg = - s dT+v dp } $$
%多行公式块格式%
$$ %% 美元符号前只能有空格
\Large \boxed{dg = - s dT+v dp }
$$
%或在多行中自由书写公式%
$$ du = \left(\frac{\partial u}{\partial s}\right)_v ds +\left( \frac{\partial u}{\partial v}\right)_s dv \rightarrow
\quad \boxed{T = \left( \frac{\partial u}{\partial s}\right)_v, \quad p = - \left(\frac{\partial u}{\partial v} \right)_s} \tag{3.1.1} $$
❌ 不支持的示例:
第一种情况是在 $$ 符号前写文本,然后将闭合 $$ 放在新行中:
this is an $$ equation 1
$$ % 这将被视为公式的开始,并可能导致自动编号错误
注意,表格中的公式将被自动忽略,不会进行自动编号。
%% 不要在 $$ 后写文本,这会停止自动编号%%
$$
Equation 2
$$ block # 公式块后的文本
对于第二种情况,如果你尝试自动编号,会收到通知 检测到第 xxx 行公式块中存在非法的嵌套 $$。你可以启用 设置 > 编辑器 > 行号 来修复它。
如果你使用本插件,应遵循以上规则。因未遵循以上规则而导致的问题可能会在不修复的情况下被关闭。