Markdown 上标和下标怎么写

Markdown 写作约 8 分钟

Markdown 本身没有上标和下标的语法,最稳的写法是 HTML,x<sup>2</sup> 和 H<sub>2</sub>O,只要渲染器放行原始 HTML 就能用,GitHub 和妙言的预览都可以。更短的 ^2^ 和 ~2~ 属于 Pandoc 和一些扩展,在妙言里波浪线那种写法会变成删除线。要写真正的公式,用 LaTeX 数学($x^2$)比这两种都合适。

四种写法

写法 上标 下标 在哪里有效
HTML 标签 x<sup>2</sup> H<sub>2</sub>O 保留原始 HTML 的渲染器
扩展语法 2^10^ H~2~O Pandoc,装了插件的 markdown-it
Unicode 字符 x² H₂O 到处都行,但只覆盖有限的字符
LaTeX 数学 $x^2$ $H_2O$ 支持数学公式的渲染器

CommonMark 核心和 GFM 规范都没有为上标下标定义语法,GFM 在 CommonMark 之上加的是表格、删除线、任务列表、扩展自动链接和对少数几个原始 HTML 标签的过滤,没有这一项。所以下面全是依赖具体工具的变通办法,同一份笔记在一个应用里正常、换一个就坏掉,原因就在这里,两份规范各自覆盖了什么见 CommonMark 和 GFM 的区别。

HTML 标签

<sup> 和 <sub> 是普通的行内 HTML,Markdown 会把行内 HTML 原样放进输出:

E = mc<sup>2</sup>

水是 H<sub>2</sub>O。

3 月 26<sup>th</sup>。

GitHub 的格式说明里写上标下标用的正是这两个标签,所以 README、issue 和评论里都能用。别的地方就不一定了,会过滤 HTML 的静态站点生成器或笔记分享服务,会把标签显示成文字或者直接丢掉。文件要拿到自己控制不了的地方去读时,它仍然是最好的选择,因为标签没渲染出来时,读者至少还能把 x<sup>2</sup> 读成「x 的平方」。

标签可以放在表格单元格、列表项和标题里,里面不能放块级 Markdown,指数里本来也用不着。

^ 和 ~ 的扩展语法

Pandoc 的 Markdown 用插入符号包住上标,用波浪线包住下标,H~2~O is a liquid. 2^10^ is 1024.。手册还加了一条规则,标记之间的文字不能有空格和换行,一定要有空格就用反斜杠转义,比如下标是「a cat」要写成 P~a\ cat~,原因是避免平时用到 ~ 和 ^ 时被误判成上下标。

markdown-it 有对应的插件,装了 markdown-it-sup 之后 29^th^ 变成 29<sup>th</sup>,装了 markdown-it-sub 之后 H~2~O 变成 H<sub>2</sub>O,两个插件都说自己的写法依照 Pandoc 的定义。它们需要自己安装和注册,所以基于 markdown-it 的工具,作者没加的话就没有。

单波浪线正是在这里变成陷阱。GFM 规范把删除线定义为一对匹配的一个或两个波浪线包住的文字,所以实现了 GFM 删除线的解析器里,~there~ 会被划掉。遵循 GFM 和遵循 Pandoc 的两种渲染器,对 H~2~O 的读法正好相反,一个得到下标,另一个得到 H、被划掉的 2 和 O。GitHub 的文档在删除线一栏同样把 ~ ~ 和 ~~ ~~ 并列写出。波浪线的规则和 3~5 这种范围写法的问题,见粗体、斜体和删除线。

妙言的预览会怎么渲染

V4.9.0 的预览用 cmark-gfm 把 Markdown 转成 HTML,Business/Markdown.swift 里创建解析器时只传了脚注选项,再按名字挂上 table、footnotes、strikethrough 和 tasklist 四个扩展,输出 HTML 时带 CMARK_OPT_UNSAFE,让 cmark 保留原始 HTML 而不是替换掉。由此可以得到各种写法的结果:

你写的 妙言预览
x<sup>2</sup>、H<sub>2</sub>O 上标和下标,由网页视图绘制
2^10^ 原样文字,插入符号保留
H~2~O H、被划掉的 2 和 O
$x^2$、$H_2O$ 由 KaTeX 排版

单波浪线的结果是设置决定的,不是偶然。cmark-gfm 的删除线扩展在没有额外设置双波浪线选项时,两边各一个波浪线也认,而这里的解析器只设了脚注选项,所以 ~2~ 会被划掉。应用自带的语法指南放在示例文件夹里,英文版写的也是 H<sub>2</sub>O 和 26<sup>th</sup>,中文版写的是 H<sub>2</sub>O 和 16<sup>世纪</sup>。速查表和下划线与颜色两篇给的是同样的建议。

预览不会过滤 HTML,所以在这里能用的标签,换个地方可能被删。<sup> 和 <sub> 因为 GitHub 放行,这点问题不大,样式和颜色就要小心。

Unicode 上下标字符

也可以直接输入这些字符,x²、m³、H₂O、10⁻⁶。它们是普通文字,所以在所有渲染器里都在,复制到聊天窗口或表格单元格也不会丢,限制有三个。

首先是覆盖面,数字 0 到 9、加号、减号、等号和括号,上标下标都有。上标的 26 个小写字母在 Unicode 16 里都有,不过上标 q 到 Unicode 14 才加入,有些字体没有。下标就少多了,Unicode 16 里的拉丁下标字母只有 a、e、h、i、j、k、l、m、n、o、p、r、s、t、u、v 和 x,所以 b、c、d、g 的下标根本没有对应字符。

其次是外观,这些字符来自不同的 Unicode 区块,字体可能对其中一部分用后备字体绘制,x¹²ⁿ 这样一串可能大小和高度不齐。最后是搜索,搜 x2 找不到 x²,因为它们是不同的字符。聊天里随手写一个指数没问题,写文档还是用标签或数学公式。

公式用数学语法

指数是公式的一部分时就写成数学。在 $...$ 里,^ 和 _ 是 LaTeX 的运算符,多于一个字符要加花括号:

$x^2$、$x_i$、$x^{10}$、$x_{ij}$

水是 $\text{H}_2\text{O}$。

数学模式会给出合适的字号和间距,变量也是斜体,还可以在同一个符号上同时放上下标(x_i^2)。妙言在解析器运行之前先把数学范围的内容保护起来,所以 $...$ 里的 _ 和 ^ 不会被当成强调。定界符和支持的函数见 Markdown 里写 LaTeX 公式。正文里的化学式用 H<sub>2</sub>O 更轻,化学式和方程写在一起时数学更合适。直接写 $H_2O$ 字母会变成斜体,因为数学模式把它们当变量,上面的例子才用 \text 包起来。

脚注标记是另一回事

脚注标记看起来像上标,其实是链接。正文里的 [^1] 加一行 [^1]: 注释 的定义,会生成一个抬高的小数字,点它跳到注释,注释里还有链接跳回来。妙言的 cmark-gfm 会自动把每个标记变成上标数字,不用自己写 <sup>。手写 <sup>1</sup> 得到的是一个不指向任何地方的抬高的 1。读者需要看注释时用脚注,抬高的文字本身就是内容时用 <sup>,比如 26<sup>th</sup>,详见 Markdown 脚注。

显示不对怎么查

  • 标签显示成文字,查看器把 HTML 转义了,改用 Unicode 字符,或者换一个允许这些标签的查看器。
  • 本该是下标的地方出现被划掉的数字,在 GFM 渲染器里写了 H~2~O,改成 H<sub>2</sub>O。
  • 插入符号一直显示,渲染器没有 ^ 扩展,妙言就是这样,改用 <sup>。
  • 公式里的字母想要直立体却是斜体,在数学里用 \text{} 包起来。
  • 预览里正常,发布后不行,先打开发布后的页面看抬高的文字在不在,再怀疑文件。

最快的检查办法是在一份笔记里把四种写法都写一遍,打开预览对比,凡是显示出插入符号、波浪线或标签文字的,都是这个渲染器不支持的写法。

常见问题

GitHub 支持上标和下标吗?

支持,用 <sup> 和 <sub>,它的格式说明里有写,说明里没有插入符号的语法。

妙言里能用 ^ 和 ~ 吗?

不能,^text^ 原样显示,~text~ 被划掉,用 <sup>、<sub> 或数学公式。

10 的负 6 次方怎么写?

HTML 写 10<sup>-6</sup>,Unicode 写 10⁻⁶,数学写 $10^{-6}$。数学里花括号不能省,^-6 只会把负号抬上去。

化学式用哪种?

正文里用 H<sub>2</sub>O,化学式和方程写在一起时用数学。