第 1 课

什么是 Markdown

理解 Markdown 作为 README、文档、Issue 和 CHANGELOG 的纯文本格式。

Markdown 是一种用纯文本表达文档结构的格式,不需要手写 HTML 标签。例如不用写 <h1>Title</h1>,而是写:

# Title

不用写 <strong>important</strong>,而是写:

**important**

核心思想是:源文保持可读,工具再把它渲染成标题、列表、链接和代码块。

开发者在哪些场景使用 Markdown

Markdown 在开发工作流中非常常见:

  • 仓库里的 README.md
  • CHANGELOG.md 发布说明
  • GitHub Issue 与 Pull Request 正文
  • 接受 .md 文件的文档站
  • RFC 笔记、Runbook 与内部指南
  • 接受由 Markdown 转换而来 HTML 的 CMS 或邮件字段

Markdown、HTML 与所见即所得编辑器的区别

格式优势典型用途
Markdown纯文本写作快、便于 diffREADME、Issue、文档源文件
HTML布局与样式控制完整CMS、邮件、网页
所见即所得可视化编辑Notion、Confluence、部分 CMS

很多团队把 Markdown 放在 Git 里,因为它适合版本控制、代码评审和跨工具复制。

关键结论

Markdown 是写作格式,不是主题或渲染器。同一份 Markdown 在 GitHub、文档站或预览工具里看起来可能不同,取决于渲染器和 CSS。

可以用 Markdown 预览 / Markdown 转 HTML 工具 试一段 README,观察源文如何变成渲染结果。

想动手练习时,可使用 DevCove 相关工具——可选,不属于本课正文。

打开相关工具

返回课程概览