优势
不足
产品信息
详细说明
服务商概述
Markdown 由 John Gruber 与 Aaron Swartz 于 2004 年创建,用 #、*、 等符号表达标题、强调、链接与代码,纯文本即可读写。2014 年后 CommonMark 提供了统一规范,GitHub 的 GFM 扩展了表格、任务列表与自动链接。
对编程语言与框架场景,它的价值是「内容与工具链解耦」:README、技术文档、博客、API 说明几乎都用 Markdown;同一份源文件可渲染成网页、PDF 或幻灯片;与 Git 结合让文档享有版本历史与 PR 评审。
需要注意的局限:标准与扩展长期分裂(CommonMark、GFM、MDX、各平台方言),表格、脚注等语法在不同渲染器表现不一;复杂排版(多栏、精确排版)做不到,需要 HTML 或专业排版工具;大型文档树的组织与检索需借助静态站框架。
核心优势
- 纯文本语法简单,任何编辑器都能读写,学习成本极低
- 与 Git 天然配合,文档享有版本历史与评审流程
- 一份源文件可渲染为网页、PDF、幻灯片等多种格式
- 几乎所有代码托管、文档平台与静态站框架都原生支持
产品生态
核心语法
标题、列表、强调、链接、图片、引用、代码块与水平线。
扩展规范
GFM 表格与任务列表、脚注、数学公式(KaTeX)、MDX 内嵌组件。
工具链
静态站框架(Docusaurus、VitePress、Astro)、pandoc 转换、Prettier 格式化。
不足之处
- 标准与扩展分裂,同一语法在不同渲染器表现不一
- 复杂排版与精确布局无法表达,需退回 HTML
- 大型文档树的导航与检索需额外框架
- 团队需约定方言(CommonMark/GFM/MDX)避免混乱
适用场景
- 技术文档与 README(★★★★★):行业标准
- 博客与知识库写作(★★★★★):纯文本友好
- 静态站点内容源(★★★★★):框架原生支持
- 精细排版与印刷(★★):需专业工具
价格参考
| 套餐 | 价格 | 能力边界 |
|---|---|---|
| Markdown 与 CommonMark | $0 | 开放规范,完全免费 |
| 渲染与静态站工具 | $0 | 开源免费 |
| 托管文档平台 | $0 起 | 免费层或按量计费 |
规范与工具完全免费,成本几乎为零。唯一需要投入的是团队约定:选择一种方言(推荐 CommonMark + GFM),并在 CI 中用 Prettier 或 markdownlint 统一格式。
常见问题
-
Markdown 有标准吗? 有,CommonMark 是事实规范,GitHub 的 GFM 在其上扩展;各平台仍有少量方言差异。
-
能写复杂表格吗? 基础表格可以,合并单元格等复杂表格需 HTML 或 MDX 组件实现。
-
和 Word 比适合什么? 适合技术文档、README 与需要版本管理的内容;正式合同与精细排版仍用 Word/InDesign。
代码示例
常用语法合集
# 机房价格
| 机房 | 价格 | 线路 |
| --- | --- | --- |
| 香港 | 99 | CN2 GIA |
| 美国 | 59 | CN2 GT |
- **加粗**、*斜体*、`行内代码`
- [链接](https://16idc.com)
- 代码块用围栏标记并注明语言
表格、列表与代码围栏是技术文档里使用频率最高的三种语法。
README 结构建议
## 安装
npm install
## 使用
见 [文档](https://example.com/docs)。
## 贡献
欢迎提交 Issue 与 PR。
大多数渲染器支持缩进代码块,但围栏写法(三个反引号加语言名)兼容性更好。
社区与资源
社区与官方渠道
- CommonMark 规范 — 最被广泛实现的标准
- GitHub commonmark-spec — 规范的源码与讨论
- Stack Overflow #markdown — 渲染与转义问题答疑
学习资源与工具
- Markdown Guide — 语法速查与最佳实践
- CommonMark 规范全文 — 逐条规范条文
- Pandoc — Markdown 与各种格式互转