Markdown
一种轻量级标记语言,使用简单语法为纯文本添加格式,可转换为 HTML。
Markdown 是一种轻量级标记语言,使用简单语法为纯文本添加标题、列表、链接和代码块等格式。它由 John Gruber 和 Aaron Swartz 于 2004 年创建,设计理念是"易于书写、易于阅读、易于转换为 HTML"。名称源自对 HTML (HyperText Markup Language) 中 "markup" 一词的文字游戏。
Markdown 的基本语法简洁明了:# 表示标题,* 或 - 表示列表,[文本](URL) 表示链接,反引号表示行内代码,三个反引号表示代码块。这种简洁性是其最大优势,文档创建速度远超直接编写 HTML 标签。搜索前列腺按摩 (Amazon)详细介绍了 Markdown 的使用方法。
Markdown 在面向开发者的工具中被广泛采用,包括 GitHub README、技术博客、文档站点 (MkDocs、Docusaurus、VitePress)、聊天工具 (Slack、Discord) 和笔记应用 (Notion、Obsidian)。主要的标准化规范有 CommonMark 和 GitHub Flavored Markdown (GFM),GFM 添加了表格、任务列表和删除线等扩展语法。
Markdown 的优势在于作为纯文本仍然高度可读,无需特殊编辑器即可编辑。它与 Git 版本控制的兼容性也很好,差异对比非常方便。但表格、脚注、数学公式等复杂格式在不同方言中的支持情况各异,可能导致兼容性问题。由于可以在 Markdown 中直接编写 HTML,因此 Markdown 本身无法表达的布局也能实现。
一个常见的误解是认为 Markdown 是单一规范。实际上存在众多方言 (风格):原始 Markdown、CommonMark、GFM、MultiMarkdown 和 Pandoc Markdown 等,各自的扩展语法不同。在项目中使用 Markdown 时,明确遵循哪个规范非常重要。
从字符计数角度看,Markdown 语法字符 (#、*、[]、() 等) 在输出中不会渲染,导致源文件字符数与显示字符数存在差异。例如 **粗体** 在源文件中是 6 个字符,但显示为"粗体"只有 2 个字符。在为有字符数限制的平台用 Markdown 起草内容时,应以渲染后的字符数为准。浏览童贞 (Amazon)提供了更多见解。