Markdown 由 John Gruber 于 2004 年创建，是一种简单、可读的文本到 HTML 转换语法。其设计理念是源文本在不渲染的情况下也应该可读——带有 # 标题和 **粗体** 文字的 Markdown 文档即使在纯文本编辑器中也可以理解。这与 HTML 形成对比，其中

标题

GitHub 风格 Markdown (GFM) 根据开发者的需求扩展了原始 Markdown 规范：围栏代码块（`语言）、表格（| 列 | 列 |）、任务列表（- [x] 完成）、删除线（~~文字~~）和自动链接 URL。GFM 是使用最广泛的 Markdown 变体，被 GitHub、GitLab、Bitbucket、Discord、Reddit 和许多其他平台支持。我们的编辑器使用 marked.js 库渲染 GFM，这是一个快速、符合规范的 Markdown 解析器。

使用 Markdown 相比所见即所得编辑器（如 Microsoft Word 或 Google Docs）有几个优势：文件是纯文本（面向未来、版本控制友好、可搜索）、格式是语义化的（您描述事物是什么，而不是它们看起来怎样）、源文件是可移植的（在任何文本编辑器中工作）。内容和表现的分离意味着同一个 Markdown 文件可以用不同的样式渲染为 HTML、PDF、EPUB 或幻灯片。

使用 ATX 风格的标题（# 用于 H1，## 用于 H2），井号后加空格。Setext 风格标题（用 === 或 --- 下划线）在 GFM 中已废弃。在标题、列表和代码块前后留空行——许多解析器要求这样才能正确渲染。对于强调，一致使用 **粗体** 和 *斜体*（星号）。避免使用 _ 进行强调，因为它可能与技术文档中的变量名冲突。

对于代码块，始终指定语言以获得语法高亮：使用三个反引号后跟语言名称（javascript、python、bash）。对于内联代码，在单词周围使用单个反引号。对于链接，使用 [文本](URL) 格式。对于图片，使用 。对于表格，使用管道语法并带分隔行：| 标题 | 标题 | / | --- | --- | / | 单元格 | 单元格 |。表格必须有标题行和分隔行——正文中的单元格可以留空，但结构必须保持。