Markdown 列表
列表是组织信息的重要方式,Markdown 支持有序列表、无序列表和任务列表。本章将详细介绍列表的各种用法。
无序列表
基本语法
使用 -、+ 或 * 创建无序列表:
markdown
- 项目一
- 项目二
- 项目三效果:
- 项目一
- 项目二
- 项目三
不同标记符号
三种符号效果相同:
markdown
- 使用减号
+ 使用加号
* 使用星号效果:
- 使用减号
- 使用加号
- 使用星号
最佳实践
建议在整个文档中使用同一种符号:
markdown
✅ 推荐(统一使用 -)
- 项目一
- 项目二
- 项目三
❌ 不推荐(混用)
- 项目一
+ 项目二
* 项目三有序列表
基本语法
使用数字加 . 创建有序列表:
markdown
1. 第一项
2. 第二项
3. 第三项效果:
- 第一项
- 第二项
- 第三项
自动编号
数字不必按顺序,Markdown 会自动排序:
markdown
1. 第一项
1. 第二项
1. 第三项效果:
- 第一项
- 第二项
- 第三项
指定起始编号
markdown
5. 第五项
6. 第六项
7. 第七项效果:
- 第五项
- 第六项
- 第七项
嵌套列表
无序列表嵌套
使用缩进(2或4个空格)创建嵌套:
markdown
- 主项目
- 子项目 1
- 子项目 2
- 子子项目 1
- 子子项目 2
- 另一个主项目效果:
- 主项目
- 子项目 1
- 子项目 2
- 子子项目 1
- 子子项目 2
- 另一个主项目
有序列表嵌套
markdown
1. 第一项
1. 子项 1.1
2. 子项 1.2
2. 第二项
1. 子项 2.1
2. 子项 2.2效果:
- 第一项
- 子项 1.1
- 子项 1.2
- 第二项
- 子项 2.1
- 子项 2.2
混合嵌套
markdown
1. 有序项目
- 无序子项
- 另一个无序子项
2. 另一个有序项目
1. 有序子项
2. 另一个有序子项效果:
- 有序项目
- 无序子项
- 另一个无序子项
- 另一个有序项目
- 有序子项
- 另一个有序子项
列表中的段落
单个段落
在列表项中添加段落,使用缩进:
markdown
- 第一项
这是第一项的详细说明段落。
- 第二项
这是第二项的详细说明段落。多个段落
markdown
1. 第一项
第一段说明。
第二段说明。
2. 第二项
第一段说明。列表中的代码块
行内代码
markdown
- 使用 `git add` 添加文件
- 使用 `git commit` 提交更改
- 使用 `git push` 推送到远程效果:
- 使用
git add添加文件 - 使用
git commit提交更改 - 使用
git push推送到远程
代码块
使用8个空格或2个Tab缩进:
markdown
1. 安装依赖
```bash
npm install
```
2. 启动服务
```bash
npm start
```列表中的引用
markdown
- 第一项
> 这是一段引用文本。
> 可以有多行。
- 第二项效果:
第一项
这是一段引用文本。 可以有多行。
第二项
列表中的图片
markdown
1. 第一步

2. 第二步
任务列表
基本语法
使用 - [ ] 和 - [x] 创建任务列表:
markdown
- [x] 已完成任务
- [ ] 未完成任务
- [ ] 另一个未完成任务效果:
- [x] 已完成任务
- [ ] 未完成任务
- [ ] 另一个未完成任务
嵌套任务列表
markdown
- [x] 主任务
- [x] 子任务 1
- [ ] 子任务 2
- [ ] 另一个主任务
- [ ] 子任务 1
- [ ] 子任务 2效果:
- [x] 主任务
- [x] 子任务 1
- [ ] 子任务 2
- [ ] 另一个主任务
- [ ] 子任务 1
- [ ] 子任务 2
任务列表应用
markdown
## 项目待办事项
- [x] 完成需求分析
- [x] 设计数据库
- [ ] 开发后端 API
- [x] 用户模块
- [ ] 订单模块
- [ ] 支付模块
- [ ] 开发前端界面
- [ ] 测试
- [ ] 部署上线定义列表
某些 Markdown 扩展支持定义列表:
markdown
术语1
: 定义1
术语2
: 定义2a
: 定义2b或使用 HTML:
markdown
<dl>
<dt>术语1</dt>
<dd>定义1</dd>
<dt>术语2</dt>
<dd>定义2</dd>
</dl>列表样式
使用表情符号
markdown
- ✅ 已完成
- ⏳ 进行中
- ❌ 已取消
- 📝 待处理效果:
- ✅ 已完成
- ⏳ 进行中
- ❌ 已取消
- 📝 待处理
使用图标
markdown
- 🎯 目标
- 💡 想法
- ⚠️ 警告
- 📌 重要效果:
- 🎯 目标
- 💡 想法
- ⚠️ 警告
- 📌 重要
列表最佳实践
1. 保持一致的缩进
markdown
✅ 推荐
- 主项目
- 子项目(2个空格)
- 子子项目(4个空格)
❌ 不推荐
- 主项目
- 子项目(3个空格)
- 子子项目(5个空格)2. 列表前后空行
markdown
✅ 推荐
这是一段文字。
- 列表项1
- 列表项2
这是另一段文字。
❌ 不推荐
这是一段文字。
- 列表项1
- 列表项2
这是另一段文字。3. 简洁明了
markdown
✅ 推荐
- 安装 Node.js
- 配置环境变量
- 运行项目
❌ 不推荐
- 首先你需要从官网下载并安装 Node.js,然后...4. 合理使用嵌套
不要嵌套太深(建议不超过3层):
markdown
✅ 推荐
- 一级
- 二级
- 三级
❌ 不推荐
- 一级
- 二级
- 三级
- 四级
- 五级(太深了)列表应用场景
1. 步骤说明
markdown
## 安装步骤
1. 下载安装包
2. 解压文件
3. 运行安装程序
4. 完成配置2. 功能列表
markdown
## 主要功能
- 用户管理
- 权限控制
- 数据统计
- 报表导出3. 待办事项
markdown
## 今日任务
- [ ] 回复邮件
- [ ] 完成报告
- [x] 参加会议
- [ ] 代码审查4. 优缺点对比
markdown
## 优点
- 简单易用
- 性能优秀
- 社区活跃
## 缺点
- 学习曲线陡峭
- 文档不够完善5. 目录结构
markdown
## 项目结构
- src/
- components/
- utils/
- styles/
- public/
- tests/
- README.md列表与其他元素组合
列表 + 链接
markdown
- [GitHub](https://github.com)
- [Stack Overflow](https://stackoverflow.com)
- [MDN](https://developer.mozilla.org)列表 + 粗体
markdown
- **重要**:这是重要内容
- **注意**:这需要注意
- **提示**:这是一个提示列表 + 代码
markdown
- 安装:`npm install`
- 启动:`npm start`
- 构建:`npm run build`常见问题
列表项之间的间距
如果需要列表项之间有更大间距,在项之间添加空行:
markdown
- 第一项
- 第二项
- 第三项列表编号重置
如果列表被其他内容打断,编号会重置:
markdown
1. 第一项
2. 第二项
这是一段文字。
1. 编号重新开始
2. 第二项列表中的特殊字符
如果列表项以数字和点开始,需要转义:
markdown
- 1984\. 这是一本书
- 2024\. 这是年份快捷键
VS Code
Ctrl/Cmd + Shift + ]:增加缩进Ctrl/Cmd + Shift + [:减少缩进
Typora
Ctrl/Cmd + ]:增加缩进Ctrl/Cmd + [:减少缩进Ctrl/Cmd + Shift + X:切换任务状态
实践练习
尝试创建以下列表:
- 一个包含3个项目的无序列表
- 一个包含5个步骤的有序列表
- 一个包含嵌套项的列表
- 一个任务列表(包含已完成和未完成)
- 一个包含代码和链接的列表
小结
列表是 Markdown 中最常用的功能之一,掌握列表的用法可以:
- 清晰地组织信息
- 展示步骤和流程
- 管理任务和待办事项
- 创建目录和导航
下一步: 学习 Markdown 引用块 的详细用法。