Markdown

一种轻量级标记语言,使用简单语法为纯文本添加格式,可转换为 HTML。

Markdown 是一种轻量级标记语言,使用简单语法为纯文本添加标题、列表、链接和代码块等格式。它由 John Gruber 于 2004 年创建。

它广泛用于面向开发者的文档编写,包括 GitHub README、技术博客和文档站点 (MkDocs、Docusaurus)。标准化规范包括 CommonMark 和 GitHub Flavored Markdown (GFM)。技术写作指南详细介绍了 Markdown 的使用方法。

Markdown 的优势在于作为纯文本仍然可读,同时易于转换为 HTML。但表格和脚注等复杂格式在不同方言中的支持情况各异。

从字符计数角度看,Markdown 语法字符 (#*[] 等) 不会显示,导致源文件字符数与渲染后字符数存在差异。文档最佳实践书籍提供了更多见解。