列表语法概览
Markdown 中常用的列表有 3 种:
- 无序列表:
-、*、+ - 有序列表:
1.、2.、3. - 任务列表(GFM 扩展):
- [ ]、- [x]
无序列表
无序列表可以使用 -、* 或 + 作为标记,后面需要加一个空格。
实际写作中建议统一使用一种符号(通常是 -),保持文档风格一致。
| |
渲染效果:
- 第一项
- 第二项
- 第三项
有序列表
有序列表使用“数字 + 英文句点 + 空格”。
| |
渲染效果:
- 第一项
- 第二项
- 第三项
自动编号技巧
很多 Markdown 解析器会自动重排序号,因此你也可以都写成 1.。
| |
渲染效果:
- 需求分析
- 原型设计
- 开发实现
列表嵌套
嵌套列表依赖缩进,建议使用 2 或 4 个空格,并在全文保持一致。
无序列表嵌套
| |
渲染效果:
- 水果
- 苹果
- 红苹果
- 绿苹果
- 香蕉
- 橙子
- 苹果
- 蔬菜
- 胡萝卜
- 白菜
有序列表嵌套
| |
渲染效果:
- 准备阶段
- 收集资料
- 制定计划
- 执行阶段
- 开始实施
- 监控进度
- 总结阶段
混合嵌套
| |
渲染效果:
- 主要任务
- 子任务 A
- 子任务 B
- 详细步骤 1
- 详细步骤 2
- 子任务 C
- 次要任务
任务列表
任务列表属于 GitHub Flavored Markdown(GFM)扩展,常用于 TODO 清单。
基本语法
| |
渲染效果:
- 未完成的任务
- 已完成的任务
- 另一个未完成的任务
实战示例
| |
渲染效果:
项目待办清单
设计阶段
- 需求分析
- 原型设计
- UI 设计
开发阶段
- 前端开发
- 页面布局
- 交互功能
- 响应式适配
- 后端开发
- 数据库设计
- API 开发
- 性能优化
测试阶段
- 单元测试
- 集成测试
- 用户验收测试
常见错误
- 列表标记后漏写空格,例如
-第一项,会导致列表不生效。 - 嵌套层级缩进不一致,导致结构错位。
- 无序列表混用
-、*、+,文档风格不统一。 - 任务列表的复选框写成
- []或- [X ],应使用- [ ]或- [x]。