In GitHub Flavored Markdown (GFM), use - [ ] for an unchecked task and - [x] for a completed one. Task lists are a GFM extension, not a feature guaranteed in every Markdown document or renderer, so check the platform where you plan to use the list.
Markdown task-list syntax
Put a list marker, a space, and a checkbox marker before each task. For example:
- [ ] Draft the document
- [x] Check the linksThe first item is unchecked; the second is marked complete. GFM accepts a whitespace character or x/X inside the brackets. Whitespace inside the brackets means the task is unchecked, and whitespace must follow the closing bracket before the task text.
Escape a leading parenthesis on GitHub
GitHub notes that a task description beginning with a parenthesis must escape it with a backslash. For example:
Do these 3 things before closing this tab:
1Repair Windows errors before they cause bigger problems2Scan for outdated or missing drivers - takes under a minute3Clear out junk files and repair common Windows errors#1 Best Overall
- [ ] (Optional) Open a follow-up issueWill task lists work in every Markdown document?
No. The GitHub Flavored Markdown specification defines task lists as an extension. Markdown processors and hosts do not all necessarily support that extension, so check the target platform’s Markdown flavor or preview the document before relying on checkbox rendering.
There are also two separate questions: whether a renderer recognizes the syntax and displays a checkbox, and whether a reader can click it to change the task’s state. GFM describes semantic checkbox output in HTML, but leaves interaction behavior to the implementation. A rendered checkbox may be disabled; another implementation may allow checking and unchecking. Seeing a checkbox does not guarantee that clicking it will update the Markdown source.
What GitHub adds
GitHub documents task lists in comments and describes platform-specific behavior beyond the basic syntax. References to issues, pull requests, or discussions can unfurl to show the referenced title and state. In a documented issue task-list case, a referenced issue’s closure can automatically complete the task. These behaviors belong to GitHub; they are not portable Markdown guarantees. See GitHub’s task-list documentation.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Check support before relying on a checklist
For a document that will be shared across editors or platforms, verify these points in the destination rather than assuming that Markdown syntax behaves the same everywhere:
Windows Errors? Fix Them Before They Spread
Repair common Windows errors and clear accumulated junk for a smoother, more stable PC - no reinstall needed.Free scan · no reinstallOutdated Drivers Are Slowing You Down
One free scan finds every outdated or missing driver and matches the right update for your exact hardware.Free scan · exact hardware matchRank #3
- Does the processor support GFM task lists?
- Does its rendered output show a checkbox?
- Can the checkbox be changed interactively, and does completion persist where you need it?
- Do any platform-specific features, such as issue-reference unfurling or automatic completion, apply there?
The GFM rules explain the syntax and rendering model, but do not establish compatibility for every renderer. Test the actual destination if task tracking depends on the result.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
