Markdown 语法速查相关工具合集

Markdown 速查工具合集:按行内与块级区分各类语法的适用位置,整理表格、删除线、任务列表等 GitHub 扩展的兼容性差异,以及代码块围栏与缩进的等价写法与自举问题,并附 Markdown 预览、HTML 格式化与文本替换工具入口。适合写 README 与文档时确认语法边界。

Markdown 语法本身不复杂,但行内与块级的边界经常被忽略,导致内容渲染不出来。

常见方案对照

维度行内元素块级元素
举例粗体、行内代码、链接列表、引用、代码块、表格
前置空行不需要必须有一个
尾随空行不需要建议有一个
能否嵌套不能可以(用 2–4 空格)
失败表现标记直接显示被上一段吞掉
常见语法粗体、行内代码、链接列表、引用、表格
缩进敏感否是(影响列表嵌套)
平台差异小大(表格与删除线是扩展)

边界条件

  • 块级元素紧跟段落不加空行时会被解析为段落的一部分,这是列表不生效的头号原因。
  • 嵌套列表用 2–4 个空格缩进,1 个空格在不同渲染器下行为不一致,超过 4 个会变成代码块。
  • 行内代码含反引号时要用双反引号包裹,否则会被提前闭合。
  • 表格与删除线是 GitHub 扩展而非 CommonMark 标准,在其他渲染器下会裸露符号。

常见坑

  • 列表紧跟在段落后不加空行,整段被当作段落文字。
  • 嵌套列表用 1 个空格缩进,GitHub 上正常但换平台就散架。
  • 引用里嵌套图片变成纯文本,因为块级元素前缺空行。
  • 在不支持表格的平台上发布,竖线符号裸露在正文中。

相关工具

常见问题

为什么我的列表没生效?

最常见的原因是**缺少空行**。块级元素(列表、引用、代码块、表格、分隔线)前面必须有空行,否则会被当成上一段的延续。行内元素(粗体、行内代码、链接)则必须紧贴文字,中间不能有空行。写完检查一遍空行,九成的问题能解决。

表格在不同平台为什么显示成源码?

因为**表格不是 CommonMark 标准**,而是 GitHub 的扩展。在 GitHub、GitLab 上正常,但在某些编辑器、文档平台、静态站点生成器里渲染不出来,竖线会裸露在页面上。需要跨平台时把表格改成列表,或改用图片。对外发布的文档优先用最基础的语法。