Task Lists

Task lists (or checklists) are a GitHub Flavored Markdown (GFM) feature. They create interactive checkboxes.

Syntax

- [ ] Unchecked item
- [x] Checked item

Example — Project Checklist

- [x] Design the homepage
- [x] Build the navbar
- [ ] Create the learn page
- [ ] Add playground feature
- [ ] Deploy to production

Nesting Task Lists

- [ ] Frontend
  - [x] Components
  - [ ] Styling
  - [ ] Testing
- [ ] Backend
  - [ ] API routes
  - [ ] Database

Important Notes

• Task lists need the dash and space before the brackets: - [ ]
• Use a lowercase x to check: - [x]
• On GitHub, you can actually click the checkboxes to toggle them!
• Not all Markdown renderers support task lists (it's a GFM extension)

Common Uses

• Project tracking
• Todo lists
• Feature checklists
• Bug reporting templates

💡 Task lists are one of the most useful features on GitHub issues and pull requests!