扩展语法 / 任务列表

任务列表

任务列表非常适合写 issue 跟进、PR 自检和发布前清单。它把“要不要继续往下做”这件事直接变成可勾选状态。

基本语法

方括号里的空格表示未完成,x 表示已完成:

  • [ ] 未完成
  • [x] 已完成
- [x] 修复暗色模式下的文字对比度
- [x] 让 Intro 页面出现在导航栏
- [ ] 替换剩余语法页的模板示例
- [ ] 复查英文页面文案

效果预览

  • 修复暗色模式下的文字对比度
  • 让 Intro 页面出现在导航栏
  • 替换剩余语法页的模板示例
  • 复查英文页面文案

常见使用场景

  • PR 提交前自检,例如“文案已校对”“截图已更新”“构建已通过”。
  • 发布准备清单,例如“切换站点地址”“确认语言链接”“同步更新记录”。
  • 文档迁移过程中的状态跟踪,方便团队知道哪些页已经重写、哪些还没动。

写作建议

  • 任务项最好写成可以直接判断完成与否的动作,避免“继续优化”这种无法打勾的表述。
  • 同一份清单里保持一种格式,例如统一使用连字符开头和小写 x
  • 如果一项任务需要解释背景,补一句说明,不要把整段背景塞进任务标题里。

评论

评论区暂未开放。

需要先为这个仓库启用 GitHub Discussions,并完成 giscus 配置后,评论功能才可用。