跳转到内容

Markdown

轻之舟百科,让知识轻装启航
Markdown
Markdown 标志
设计者John Gruber、Aaron Swartz
首次发布2004年3月
标准CommonMark
类型轻量标记语言
官方网站daringfireball.net

Markdown 是一种轻量标记语言,2004 年由 John Gruber 与 Aaron Swartz 设计。它用最少的符号表达标题、列表、链接、强调和代码块,写出来的纯文本即使不渲染也能读。最初只是一个把 Markdown 转成 HTML 的 Perl 脚本,后来变成了写文档的通用格式。[1]

Markdown 的流行和 GitHub 分不开。README、issue、pull request 和评论都支持 Markdown,很多人的第一篇技术文档就是用井号标题和短横线列表写的。

2004 年,John Gruber 在 Aaron Swartz 的帮助下发布了 Markdown。它的目标是让写作者用纯文本写作,同时能方便地转成 HTML。Gruber 写了最初的 Perl 转换脚本,但很长一段时间里,Markdown 只有语法说明,没有正式规范。

各家的解析器对边界情况处理不一致,同一个文件在不同工具里可能渲染出不同结果。2014 年,CommonMark 项目开始制定严格规范;2017 年发布 1.0 版。

Markdown 的语法很少。行首的井号表示标题,短横线或数字加句点表示列表,星号或下划线包裹文字表示强调,方括号加圆括号表示链接,反引号包裹代码,三个反引号包裹代码块。大于号表示引用,连续三个短横线表示分隔线。

Markdown 允许直接嵌入 HTML。这很方便,但也导致不同实现的行为不一致。表格、任务列表、删除线和自动链接最初不在 Markdown 里,是 GitHub 等平台后来加的扩展。

标准化与方言

[编辑 | 编辑源代码]

CommonMark 用测试用例定义每个语法细节,解决了很多歧义。GitHub 在 CommonMark 基础上加入表格、任务列表、删除线和自动链接,形成 GitHub Flavored Markdown(GFM)。GFM 现在是很多文档工具的事实标准。

除此之外还有 Markdown Extra、MultiMarkdown、MDX 等方言。MDX 允许在 Markdown 里写 React 组件,常用于文档站点。

Markdown 被用于代码仓库的 README 和文档、静态网站生成器(Hugo、Hexo、VitePress、MkDocs)、笔记软件(Obsidian、Logseq、Typora)、论坛和评论系统。配合 Pandoc,它还可以转成 PDF、LaTeX 和 Word。

Markdown 不是为复杂排版设计的。精细的表格、脚注、交叉引用和数学公式通常要扩展语法,或者换用 AsciiDoc、LaTeX。

参考文献

[编辑 | 编辑源代码]
  1. ↑ John Gruber. Markdown. 2004-03-19 [2026-11-18].