为什么选择Markdown?
Markdown由John Gruber于2004年创建,目标是"让写作者专注于内容,而不是格式"。相比Word等富文本编辑器,Markdown有三大优势:纯文本格式,可以用Git版本管理;编写速度极快,手不需要离开键盘;一次编写,多种输出(HTML、PDF、电子书)。
如今,GitHub、Stack Overflow、掘金、知乎、Notion等主流平台都支持Markdown。掌握Markdown已经成为开发者的必备技能。
基础语法速查
Markdown的语法非常简洁,只需要记住少量规则:
- 标题:# 一级标题,## 二级标题,### 三级标题(最多6级)
- 粗体:**粗体文本**
- 斜体:*斜体文本*
- 链接:[链接文字](URL)
- 图片:
- 代码:行内代码用反引号,代码块用三个反引号
- 列表:- 无序列表,1. 有序列表
- 引用:> 引用文本
- 分割线:---
高级技巧
表格:使用|和-创建表格,可以通过:设置对齐方式。表头和数据行用|分隔,对齐行用:---(左对齐)、:---:(居中)、---:(右对齐)。
任务列表:- [ ] 未完成 / - [x] 已完成,在GitHub上可以直接勾选。
脚注:[^1]定义引用,[^1]: 解释文本在文末显示详细说明。
数学公式:行内公式用$包裹,独立公式用$$包裹。部分平台支持KaTeX渲染。
技术文档写作规范
好的技术文档不只是语法的堆砌,还需要遵循写作规范:标题层级不要跳级(不要从h1直接到h3);代码块标注语言类型(如javascript、python等);图片添加替代文字;链接使用有意义的文字(避免"点击这里");中英文之间加空格(提升可读性);段落不要太长(每段3-5句话)。
Markdown的扩展方言
不同平台对Markdown有不同扩展:GitHub Flavored Markdown(GFM)增加了表格、任务列表、删除线、自动链接;CommonMark试图标准化Markdown的解析行为;MDX允许在Markdown中嵌入React组件。了解你使用的平台支持哪些扩展,避免写出不兼容的语法。
工具推荐
使用我们的在线Markdown预览器,左右双栏实时编辑预览,支持标题、列表、代码块、表格等常用语法,内置快捷工具栏,帮助你快速编写和预览Markdown内容。