夜雨聆风学习资料网

ARTICLE · 1121483

Markdown系列二:md 文档怎么加表格、打勾、写公式?

Markdown系列二:md 文档怎么加表格、打勾、写公式?
点上方关注,一夜暴富

一份笔记在自己的编辑器里有表格、有勾选框,复制到另一个平台后,可能只剩一排竖线和方括号。公式更明显:原来排得整齐的分数,转眼变成了一串美元符号和反斜杠。

问题未必出在你写错了。标题、列表等基础语法之外,很多常用功能属于扩展,不同编辑器支持的范围并不相同。

01 先分清“写法”和“支持”

CommonMark 对基础 Markdown 的解析行为作了明确规定。GitHub Flavored Markdown,简称 GFM,在此基础上加入表格、任务列表、删除线等扩展。

脚注、数学公式、Mermaid 流程图又有各自的支持条件。即使某个平台支持其中几种,也不代表它支持所有扩展。例如 GitHub 的产品功能与 GFM 规范本身,就不是完全相同的范围。

因此,看到“支持 Markdown”时,还需要问一句:具体支持哪些写法?编辑器里的预览结果,也不一定等于发布平台里的最终效果。

02 表格和待办清单,最容易用上

表格适合比较,不适合塞进大段解释。下面是一张可以直接练习的小表:

| 任务 | 责任人 | 截止日期 | | :--- | :---: | ---: | | 整理资料 | 小林 | 10月8日 | | 检查图片 | 小陈 | 10月9日 |

第一行是表头,第二行是分隔行。冒号在左、两侧或右侧,分别表示左对齐、居中和右对齐;实际样式仍可能受平台主题影响。

如果单元格里必须出现竖线,在 GFM 表格中可写成 \|,避免它被当成下一列的分隔符。每行列数尽量一致,也更方便检查。

表格里的换行要谨慎。部分环境允许 <br>:

| 项目 | 说明 | | --- | --- | | 资料检查 | 核对链接<br>确认图片可见 |

如果目标平台过滤 HTML,这个换行就可能失效。单元格里需要长段落或多级列表时,直接拆成小节往往更易读,尤其是在手机上。

待办清单的写法是:

- [ ] 整理会议记录 - [x] 确认参与人员 - [ ] 发出下次会议通知

方括号中间的空格表示未完成,x 表示已完成。预览为勾选框,并不意味着一定能直接点击修改状态;是否可交互,要看平台和编辑权限。

删除线可以标出已取消的信息:~~原定周三开会~~。如果只是想表示任务完成,勾选框通常更明确。

03 脚注、目录和折叠内容

脚注适合放不宜打断正文的来源或解释:

这个术语在不同资料中有不同译法[^note]。  [^note]: 此处补充译法或资料出处。

脚注标记与定义中的名字必须对应。预览没有生成脚注时,先检查平台支持情况,再检查拼写。

目录有两种常见做法。某些编辑器识别 [TOC] 并自动生成目录;它不是通用语法,换个地方可能原样显示。

手工目录则靠链接跳到标题:

- [安装说明](#安装说明) - [使用方法](#使用方法)  ## 安装说明  这里写安装步骤。  ## 使用方法  这里写使用说明。

标题中有空格、标点、英文大小写或重复名称时,各平台生成的锚点可能不同。发布后实际点击一遍,比只检查源文件可靠。

折叠内容通常使用 HTML:

<details> <summary>查看补充说明</summary>  这里放置不必在正文中展开的内容。  </details>

这段代码只有在允许相关 HTML 的环境中才可能生效。折叠区域内能否继续解析 Markdown,也要看编辑器;准备发到公众号时,不应依赖这种交互效果。

04 数学公式和流程图

支持数学排版的编辑器通常可以识别行内公式:

质能关系式:$E=mc^2$

需要单独成行的公式,常见写法是:

$$ \frac{-b \pm \sqrt{b^2-4ac}}{2a} $$

这里用的是 LaTeX 风格的数学语法,但并不等于编辑器支持完整的 LaTeX 文档。支持哪些命令、怎样开启公式功能,要看所用工具。

流程图常用 Mermaid。它是在代码块里描述节点和关系,再交给相应的渲染器生成图形:

```mermaid graph LR     A[收集资料] --> B[整理正文]     B --> C[检查内容]     C --> D[发布] ```

没有 Mermaid 支持的地方,这段内容通常只会作为代码显示。需要发到公众号或放入不支持该功能的文档时,可以先在可信工具里渲染为图片,再插入正文,最后检查字是否清晰。

05 其他写法,用到再查

==高亮==、H~2~O 和 X^2^ 分别是一些编辑器支持的高亮、下标和上标写法,都不是所有 Markdown 环境通用的功能。

表情也要分开看:直接输入的 Unicode 表情是文字字符,显示外观由设备决定;:smile: 这样的短代码,需要平台额外识别。教程不需要为了演示它,就给每个标题都加一个表情。

基础 Markdown 没有统一的字体和颜色控制语法。有些平台允许 HTML 样式,例如:

<span style="color:#31594d;">补充说明</span>

另一些平台会移除这些样式。对整篇文章而言,通过编辑器主题统一控制字体、行距和颜色,通常比给每句话单独设样式更好维护。

写给多个平台的文档,可以把标题、段落、列表作为骨架,再按发布环境增加扩展。这样遇到兼容问题时,容易找到是哪一层出了问题,也不必整篇重写。

本系列文章

Markdown入门系列一:md 文档是啥?和 txt、Word 文档有什么区别?

正在阅读 · Markdown入门系列二:md 文档怎么加表格、打勾、写公式?

Markdown入门系列三:读书笔记、会议记录,怎么用 md 来写?

Markdown入门系列四:怎么用 md 给软件写一份说明书?

Markdown入门系列五:md 文档用什么软件写?怎么转成 PDF、发到公众号?

相关学习资料