Markdown Checklist: Task Lists and Checkboxes

To create a checklist or task list in Markdown, use a hyphen followed by square brackets: - [ ] for an unchecked item and - [x] for a checked item (with a space inside the empty bracket).

Syntax Code Snippet
- [x] Research privacy-first developer tools
- [x] Build 100% browser-based JSON formatter
- [ ] Deploy static site to Vercel
- [ ] Share with development community
Rendered HTML Output Preview
  • Research privacy-first developer tools
  • Build 100% browser-based JSON formatter
  • Deploy static site to Vercel
  • Share with development community

Platform Compatibility & Differences

GitHub (GFM):

Fully interactive! Clicking checkboxes in GitHub issues/PRs updates the underlying markdown source.

Discord Chat:

Discord does NOT render interactive checkboxes.

Reddit:

Supported in Fancy Pants editor.

Jupyter Notebooks:

Supported in JupyterLab Markdown cells.

How to Use Markdown Checklist

  1. Copy the ready-to-use Checklist / Task Lists syntax snippet below.
  2. Inspect the rendered live preview in both light and dark themes.
  3. Review platform compatibility differences for GitHub, Discord, Reddit, and Jupyter notebooks.
  4. Check common pitfalls and copy formatted snippets directly.

Practical Examples

Checklist / Task Lists Syntax Pattern

Task lists let project maintainers track todos, requirements, and pull request review items directly in markdown files.

Input:
- [x] Research privacy-first developer tools
- [x] Build 100% browser-based JSON formatter
- [ ] Deploy static site to Vercel
- [ ] Share with development community
Output:
Rendered visual format

Common Mistakes & Troubleshooting

  • Omitting the space between brackets: `-[ ]` will not render.
  • Forgetting the space after the hyphen: `- [ ]Task` will not render.

Frequently Asked Questions

Can I make task lists clickable for users?

On platforms like GitHub and GitLab, task lists in issues and pull requests are clickable by users with write access.