技术文档排版
团队维护的 API 文档里，代码块与正文混排，缩进和列表层级全靠肉眼对齐，每次发布前都要花 20 分钟人工校对。用本速查表定位到「代码块」「有序列表」「引用」三个语法块，复制示例后直接替换内容，无需切换编辑器预览。一个 50 页的接口文档，排版时间从 20 分钟压到 3 分钟，且不再出现缩进错位导致的渲染失败。
语 法 分 类标题 · 强调 · 列表 · 链接图片 · 代码 · 引用 · 表格 · 其他 · GFM 扩展
语 法 对 照每条：① 语法源码（点复制） ② 实时渲染效果（marked） ③ 中文说明
在 线 试Playground · 左侧输入 Markdown，右侧 marked 实时预览（赤金样式）
MARKDOWN在此输入
预 览实时渲染
就绪 · 语法源码↔实时渲染三列对照 · 含 CommonMark + GFM 扩展 · 渲染引擎 marked 全程浏览器本地
第一节
关于本工具
About写技术文档或代码注释时，经常要查某个 Markdown 语法怎么写——表格竖线对齐、任务列表的方括号、脚注的锚点。这个速查表把全部标准语法按类型排好，每条配可复制的示例代码和渲染效果，点一下就能把原始格式粘到编辑器里。页面本身就是纯 HTML，不联网也能打开，所有内容都在本地。
使用场景
GitHub 仓库 README
开源项目在 GitHub 上托管，README 里需要同时展示安装命令、参数表格、徽章图标。新手常因表格竖线对齐不准导致 Markdown 渲染成纯文本，或者把图片语法写成 HTML 标签而被仓库屏蔽。速查表里「表格」「图片」「链接」三个语法块直接给出标准格式，复制后替换路径和文字即可。一个包含 6 行表格的 README，从反复试错到一次通过，耗时从 15 分钟降到 2 分钟。
博客文章转笔记
写技术博客时用 Markdown 排了代码块、高亮、脚注，但想把这篇文章同步到 Notion 或 Obsidian 个人笔记库时，发现两个平台的 Markdown 解析差异：脚注语法不兼容，代码块需要指定语言才能高亮。速查表里「脚注」「代码块语言标识」「删除线」三个语法块，分别列出各平台支持情况，直接复制兼容性最好的写法。一篇 3000 字的博客，迁移时间从 40 分钟缩短到 10 分钟，且保留全部格式。
简历排版自救
用 Markdown 写简历投递技术岗位，在线编辑器预览时工作经历列表自动缩进成无序列表，但复制到 Word 或 PDF 后，缩进丢失、加粗变成星号。速查表里「加粗」「换行」「水平分割线」三个语法块，分别给出在 Typora、VS Code、GitLab 三种编辑器下的渲染差异，直接选用通用写法。一份 5 个模块的简历，从排版错乱到格式统一，花费时间从 1 小时降到 15 分钟。
Markdown 转微信推文
运营同学用 Markdown 写公众号初稿，但微信编辑器不支持 Markdown 原生语法，需要手动把「# 标题」转成 H1 样式、「- 列表」转成微信编辑器里的列表按钮。速查表里「标题层级」「任务列表」「行内代码」三个语法块，直接给出微信编辑器对应的快捷键或按钮位置，复制示例后对照操作。一篇 2000 字的推文，从逐段手动转换到 5 分钟完成，且不再出现标题层级混乱。
第二节
使用指南
Getting Started使用步骤
- 1在左侧语法分类栏中点击「标题」「列表」或「代码」等标签，右侧立即展示对应的 Markdown 写法与渲染效果
- 2点任一语法行末尾的「复制」图标，该语法代码直接存入剪贴板，无需手动选中文本
- 3在页面顶部的搜索框输入关键词（如「表格」「链接」），实时过滤出匹配的语法条目，高亮显示命中位置
- 4展开任意语法条目下方的「示例」区域，查看该语法在编辑器中的原始写法与最终渲染对比图
输入输出示例
| 输入 | 输出 | 说明 |
|---|---|---|
| # 一级标题 ## 二级标题 ### 三级标题 | # 一级标题 ## 二级标题 ### 三级标题 | 常规：展示标题语法从一级到三级的完整写法，是 Markdown 文档结构的基础 |
| **粗体** *斜体* ~~删除线~~ `行内代码` | **粗体** *斜体* ~~删除线~~ `行内代码` | 常规：集中展示四种最常用的行内格式，验证语法组合的正确解析 |
| | 左对齐 | 居中 | 右对齐 | | :--- | :---: | ---: | | 左 | 中 | 右 | | | 左对齐 | 居中 | 右对齐 | | :--- | :---: | ---: | | 左 | 中 | 右 | | 边界：表格对齐语法（冒号位置）是新手易错点，验证冒号在左/中/右三种位置的正确渲染 |
| ```python print("Hello") ``` | ```python print("Hello") ``` | 边界：代码块带语言标识，验证围栏代码块 + 语言高亮标记的完整输出，不含多余转义 |
| [链接](https://example.com) 和  | [链接](https://example.com) 和  | 易错：链接与图片语法仅差一个感叹号，用户常混淆；验证两种格式的区分输出 |
| > 第一层引用 > > 第二层引用 > > > 第三层引用 | > 第一层引用 > > 第二层引用 > > > 第三层引用 | 边界：多层嵌套引用，验证 > 符号递增的正确解析，避免合并或丢失层级 |
| - 无序列表 1. 有序列表 - 嵌套无序 1. 嵌套有序 | - 无序列表 1. 有序列表 - 嵌套无序 1. 嵌套有序 | 易错：混合嵌套（无序套有序、有序套无序），验证缩进和编号重置规则 |
| \*这不是斜体\* 和 \`这不是代码\` | \*这不是斜体\* 和 \`这不是代码\` | 易错：反斜杠转义特殊字符，验证转义符是否被正确保留而非被吃掉 |
常见错误对照
1.代码块语言标识后漏了换行
✗ 错误
```python
print('hello')```✓ 修复
```python
print('hello')
```Markdown 代码块的结束符 ``` 必须单独成行，否则会被解析器当作内联代码或导致代码块未闭合。
2.列表嵌套时缩进不足
✗ 错误
- 水果
- 苹果
- 香蕉✓ 修复
- 水果
- 苹果
- 香蕉子列表项需要比父列表多至少 2 个空格（或 1 个 Tab），否则解析器会当作新列表开始，破坏层级。
3.表格中竖线未对齐或缺少分隔行
✗ 错误
| 姓名 | 年龄 |
张三 | 25 |✓ 修复
| 姓名 | 年龄 |
| --- | --- |
| 张三 | 25 |Markdown 表格必须包含表头分隔行（至少 3 个短横线），且每行首尾竖线可选但建议统一。
4.链接文本和 URL 之间多了空格
✗ 错误
[百度] (https://baidu.com)✓ 修复
[百度](https://baidu.com)Markdown 链接语法中，] 与 ( 之间不能有空格，否则部分解析器会视为纯文本而非链接。
5.引用块内嵌套列表时缺少空行
✗ 错误
> - 第一项
> - 第二项✓ 修复
>
> - 第一项
> - 第二项引用块内的列表需要先有一个空引用行（>），否则列表符号会被当作引用文本的一部分，破坏列表解析。
6.标题的井号后忘了空格
✗ 错误
#标题✓ 修复
# 标题ATX 标题语法要求 # 后紧跟一个空格，否则部分解析器（如 GitHub）不会识别为标题。
7.任务列表方括号大小写混用
✗ 错误
- [X] 已完成
- [x] 未完成✓ 修复
- [x] 已完成
- [ ] 未完成任务列表的勾选状态统一用小写 x 表示完成，空格表示未完成；大写 X 在某些渲染器中不被识别。
第三节
工作原理
How It Works核心公式
Markdown 渲染 = 解析器(源文本) → AST → 渲染器(HTML)
变量说明
源文本用户输入的 Markdown 原始字符串AST抽象语法树，结构化表示文档层级HTML最终输出的超文本标记语言
示例
输入源文本 `# 标题`，解析器识别为 h1 节点（AST），渲染器输出 `<h1>标题</h1>`。速查表中所有语法均按此流程实时转换，示例代码一键复制即得对应 HTML。
用户输入
本地处理
输出结果
第五节
常见问题
Q & A问这个速查表能复制代码吗？还是只能看？＋
答
每个语法块右上角都有一个复制按钮，点击直接复制 Markdown 源码到剪贴板，不需要手动框选。包括表格、代码块、LaTeX 公式等复杂结构，复制出来的格式就是可以直接粘贴到编辑器里生效的原文。如果复制后粘贴出来是纯文本，检查一下浏览器剪切板权限是否被拦截，或者换个编辑器（如 VS Code / Typora）试试。
问为什么表格的写法跟我在 GitHub 上看的不一样？＋
答
GitHub 的 Markdown 表格支持对齐冒号（`:---` / `:---:` / `---:`）和单元格内换行，但很多本地编辑器（如 Typora、Notion）只支持基础的对齐语法。本速查表同时列出了标准 GFM 表格和一种兼容性更好的写法——用 HTML `<table>` 标签，适用于需要严格对齐、跨行合并或内嵌列表的场景。如果发现复制后表格在目标平台错位，优先检查分隔行（第二行）的短横线数量是否足够，或者直接切到 HTML 写法。
问LaTeX 公式用双美元符还是单美元符？＋
答
本表同时给出了行内和块级两种用法：行内公式用单个 `$` 包裹，块级公式用双 `$$` 包裹。但不同渲染引擎对定界符的解析不一致，比如 GitHub 的 README 只认 `$$` 块级，不认 `$`；而 Typora 两种都认。如果复制公式后没渲染出来，先确认目标平台是否启用了 MathJax / Katex，然后把行内公式改成 `\( ... \)` 试试——这是最通用的 LaTeX 文本模式写法，几乎所有引擎都支持。
问我最常用的语法就那么几种，能不能只看重点？＋
答
页面左侧有分类锚点导航，点击「标题」「列表」「代码」「表格」「引用」「链接」「图片」「公式」「表情」可以直接跳转到对应区块，不用上下翻找。另外每个分类标题旁边标了该语法在主流平台（GitHub、Typora、Notion）的兼容性图标——打勾表示完全支持，圆点表示部分支持，空白表示不支持。如果只关心某个平台，按图标筛选着看就行。
问为什么我贴到微信公众号编辑器里格式乱了？＋
答
微信公众号后台使用的富文本编辑器对 Markdown 支持很差，不支持原生 Markdown 渲染。本表在「兼容性参考」部分标注了各语法在微信编辑器中的表现：标题 / 加粗 / 斜体 / 链接 / 有序列表可以正常显示，但表格、代码块、图片、LaTeX 公式全部失效。正确做法是先用本表复制 Markdown 源码，再用第三方工具（如 Md2All、WeChat Format）转换成微信支的 HTML 后再粘贴。
问速查表里的语法是不是所有 Markdown 编辑器都能用？＋
答
不是。本表按「通用」和「扩展」分类标注：通用语法（标题、加粗、斜体、列表、引用、链接、图片）在几乎所有 Markdown 引擎里一致；扩展语法（表格、代码块高亮、任务列表、LaTeX 公式、脚注、目录）在不同平台上有差异。比如「任务列表」在 GitHub 和 Typora 里用 `- [x]` 写法，但 Notion 不支持纯文本渲染；「脚注」只在少数编辑器（如 Typora、Markdown Here）有效。每个扩展语法块右上角有「兼容性」标签，点击可展开该语法在 8 个主流平台的详细支持情况。
问这个页面能离线用吗？没网的时候能不能打开？＋
答
可以。本工具是纯前端实现（FE），所有语法说明、示例和复制功能都在页面加载时一次性下载到本地。首次访问后浏览器会缓存静态资源，断网后重新打开该 URL 仍然可以正常查看和复制。但需要注意：如果清理了浏览器缓存或开启了无痕模式，离线访问会失效。另外页面本身不依赖任何后端接口，所以不会因为服务器宕机而无法使用。
问我写的 Markdown 文件很大，这个页面打开会卡吗？＋
答
本页面是阅读型速查表，不是编辑器，不加载用户文件，所以不存在卡顿问题。页面本身大小约 200KB（含所有示例和样式），在 4G 网络下 2 秒内可完全加载。如果感觉滚动或点击复制按钮卡顿，通常是浏览器扩展（如广告拦截器、语法高亮插件）干扰了页面事件。可以尝试在无痕窗口打开，或者暂时禁用那些对 Markdown 页面做自动处理的扩展。
隐私保证所有计算与处理均在你的浏览器本地完成，输入数据不会上传服务器，也不会保存或共享。