Markdownチュートリアル

任务列表

markdown任务列表的创建和列表相似

任务列表语法

任务列表可以创建带有选框的项目列表。在支持任务列表的Markdown应用程序中,复选框将显示在内容旁边。

要创建任务列表,要在任务项前添加 - [ ]。并在[ ]前添加一个空格 要选择一个复选框,请在[ ]中添加x

- [ ] Task 1
- [x] Task 2

渲染效果如下:

  • Task 1
  • Task 2

嵌套任务列表

您可以通过缩进任务项来创建嵌套任务列表。

- [ ] Main task
  - [ ] Subtask 1
  - [x] Subtask 2
  - [ ] Subtask 3
- [x] Another main task

渲染效果如下:

  • Main task
    • Subtask 1
    • Subtask 2
    • Subtask 3
  • Another main task

任务列表最佳实践


使用清晰的任务描述

编写清晰且可执行的任务描述。

- [ ] 审查项目提案
- [ ] 安排团队会议
- [x] 更新文档

分组相关任务

将相关任务分组以获得更好的组织。

## 项目设置
- [ ] 初始化仓库
- [ ] 设置CI/CD管道
- [ ] 配置环境变量

## 开发
- [ ] 实现核心功能
- [ ] 编写单元测试
- [ ] 代码审查

使用一致的格式

在整个任务列表中保持一致的间距和格式。 参照列表的语法列表