跳到主要内容
返回博客
2026年11月2日星期一

Markdown 实用速查:写清文档,再导出分享

围绕一份完整小文档,核对标题、强调、列表、引用、链接、表格、任务和代码的常用写法。通过第二段示例补充缩进、转义与嵌套围栏,区分核心语法和 GFM 扩展,再用真实导出图片检查结构、行长与最终的阅读效果。

Markdown 实用速查:写清文档,再导出分享

速查表的用途是帮你完成文档,不是背下每一种 Markdown 方言。写作时打开 Markdown 速查表,再用本文核对常用语法及其显示效果。这里集中介绍文档的常见组成部分,公式和图表等专门语法应查各自的参考资料。

从一份完整的小文档开始

下面把标题、行内样式、列表、引用、链接、表格和任务放在同一份示例中。整体复制进去,观察它们如何组合,比逐个试符号更容易理解。

# Markdown field guide

## Inline text
**Bold**, *emphasis*, and `inline code`.

## Lists
- First item
- Second item

> A short quotation.

[Documentation](https://spec.commonmark.org/current/)

| Item | State |
|:--|:--|
| Draft | Reviewed |

- [x] GFM task list

Markdown 速查示例的导出图,含行内样式、列表、引用、表格和任务项

导出图片展示了视觉层级。Markdown 原稿也要保存:文字和链接地址在原稿中仍可编辑,PNG 则只是视觉副本。

按用途理解语法符号

  • 章节: #、##、### 后接空格,表示逐级降低的标题。标题级别由文档结构决定,不要只为某张卡片里的字号随意选级别。
  • 行内含义: **bold** 突出重点,*emphasis* 表示较轻的强调,反引号用于短代码标识。避免把整个段落都加粗。
  • 列表: 无序项使用 - ,步骤使用数字、英文句点和空格。子项缩进到父项下面。不同块之间留空行,原稿更容易检查。
  • 引用: 引用行以 > 开头。引用他人内容时,在附近说明来源。
  • 链接与图片: [label](URL) 创建链接。图片沿用方括号与圆括号结构,在前面加感叹号,方括号里写图片描述。

增加结构前,确认渲染器支持什么

表格、任务列表和删除线属于 GFM 扩展,并非所有 Markdown 渲染器都支持。CommonMark 规范与 GFM 规范区分了基本规则和扩展。请在最终使用的环境里预览这些功能。

第二段示例补充了带子项的有序列表、原样显示的星号、分隔线和围栏代码块。外层用四个反引号,才能在本文中完整展示内层三个反引号的写法。

### A smaller section

1. Review the draft
   - Check the facts
2. Export the result

~~Old wording~~ and \*literal asterisks\*.

---

```javascript
console.log("Ready");
```

代码围栏后的语言标识帮助渲染器选择高亮方式,不会运行程序,也不能证明代码正确。

把检查过的文档转成图片

核对语法后,将文档粘贴进 Markdown 转换器。选择能让最长一行和表格清晰显示的宽度。除了编辑器预览,还要检查下载文件;重要链接放在配文中,因为图片不会保留可点击的 Markdown 链接。

把交互式速查表放在手边。具体故障参阅常见 Markdown 错误,长代码和围栏处理参阅代码块指南。