Markdown 速查表
Markdown 语法快速参考 — 标题、列表、链接、代码块、表格等,附实时渲染预览。
使用方法
- 查看左侧目录,点击跳转到对应语法分类。
- 每张卡片左侧显示原始 Markdown 语法,右侧显示渲染效果。
- 点击复制按钮,将 Markdown 片段复制到剪贴板。
- 可直接用于 GitHub、Notion、VS Code、Obsidian 等 Markdown 编辑器。
常见问题
-
什么是 Markdown?
Markdown 是由 John Gruber 于 2004 年创建的轻量级标记语言。它允许使用纯文本符号来表示格式,例如用 ** 包裹文本使其加粗。Markdown 文件会被 GitHub、博客平台、文档工具和笔记应用中的渲染器转换为 HTML。
-
不同平台的 Markdown 语法一样吗?
基础语法基本一致,但各平台支持的扩展有所不同。GitHub Flavored Markdown (GFM) 新增了任务列表、删除线和表格等功能。Obsidian 支持双链语法。部分平台以 CommonMark 为标准。本速查表重点涵盖最广泛支持的语法特性。
-
Markdown 中如何换行?
在行末加两个空格后按 Enter 可实现软换行。两行之间留一个空行则形成段落分隔。在大多数渲染器中,没有尾随空格的单个换行符会被当作空格处理,而非换行。
-
Markdown 中可以使用 HTML 吗?
大多数 Markdown 渲染器允许内联 HTML。例如可以用 <br> 换行、<u>文本</u> 下划线,或用 <details> 创建折叠区块。但支持程度各异 — 一些注重安全性的渲染器会完全过滤 HTML。
什么是 Markdown?
Markdown 是一种可转换为 HTML 的纯文本格式化语法。由 John Gruber 于 2004 年创建,其设计目标是让原始文本本身即具备可读性 — 即使不经渲染,也应像格式化文本一样清晰。如今它被广泛应用于 GitHub README、技术文档、博客平台、Obsidian 和 Notion 等笔记应用,以及 Slack 和 Discord 等聊天工具。
核心理念简单直接:用普通字符表示格式。# 开头的行变成标题,** 包裹的文本变为粗体,缩进四个空格的行成为代码块。这些约定足够直观,大多数开发者无需系统学习便能掌握。
Markdown 速查表的用途
即使是经验丰富的写作者,偶尔也会忘记表格对齐、嵌套列表或带语言标识的代码块的确切语法。速查表提供快速查阅 — 左右并排显示原始语法和渲染效果,无需猜测输出结果。
本速查表涵盖:
- 标题 — h1 到 h4 共六个层级
- 文本格式 — 粗体、斜体、删除线、行内代码、超链接
- 列表 — 有序、无序、嵌套和任务列表
- 链接与图片 — 内联链接、带标题的链接、图片
- 引用块 — 单层与嵌套引用
- 代码块 — 带可选语言标识的围栏式代码块
- 表格 — 支持列对齐选项
- 分割线 — 用作视觉分隔符
Markdown 方言
基础 Markdown 规范故意设计得极简。各工具对其进行了不同程度的扩展:
CommonMark 是一个标准化规范,解决了原始规范中的歧义问题。GitHub、GitLab、Discourse 等众多平台遵循 CommonMark 或与之相近的标准。
GitHub Flavored Markdown (GFM) 新增了任务列表(- [x])、删除线(~~文本~~)、表格和自动链接功能,大多数代码托管平台均支持 GFM 或其超集。
MDX 将 Markdown 与 JSX 结合,允许内联嵌入 React 组件,常用于基于 Next.js、Astro 等框架构建的文档站点。
对于日常技术写作 — README、文档、博客、笔记 — 标准 CommonMark 加 GFM 扩展已能满足几乎所有需求。
高质量 Markdown 写作技巧
保持列表标记一致。 选定 - 或 * 作为无序列表标记后统一使用。混用虽合法,但在源码中可读性较差。
在块级元素之间使用空行。 标题、代码块和引用块前后保留空行,可确保在不同解析器中正确渲染。
优先使用围栏式代码块。 三个反引号的代码块支持指定语言以启用语法高亮,且在源码中视觉上更清晰。
避免深度嵌套列表。 三层或更多级嵌套在源码和渲染后都难以阅读,建议改用带标题的章节来重新组织内容。
使用描述性链接文本。 [点击这里](url) 远不如 [Markdown 规范](url) 在可读性和可访问性上表现出色。