MarkdownPaper Open reader

Guide

Markdown checkboxes and task lists

To add a checkbox in Markdown, start a list item with - [ ] for an empty box or - [x] for a ticked one. Put a space inside the empty brackets and a space after them.

You write

- [x] Book the venue
- [x] Send the invitations
- [ ] Order the cake
- [ ] Confirm the music

You see

  • Book the venue
  • Send the invitations
  • Order the cake
  • Confirm the music

This is called a task list. It comes from GitHub Flavored Markdown, and most Markdown apps support it.

On this page

Ticked boxes

A lower case x or a capital X both tick the box.

You write

- [x] Done
- [X] Also done
- [ ] Not done yet

You see

  • Done
  • Also done
  • Not done yet

Nested tasks

Indent tasks under another task to break a job into steps.

You write

- [ ] Launch the website
  - [x] Write the pages
  - [x] Check the links
  - [ ] Point the domain

You see

  • Launch the website
    • Write the pages
    • Check the links
    • Point the domain

Tasks in a numbered list

The box works after a number too.

You write

1. [x] Back up the database
2. [ ] Run the migration
3. [ ] Check the logs

You see

  1. Back up the database
  2. Run the migration
  3. Check the logs

Can you click the boxes?

That depends on the app.

  • On GitHub, boxes in issues and pull requests can be ticked by clicking. In a .md file in a repository, you change them by editing the file.
  • In the MarkdownPaper reader, clicking a box ticks it and changes the [ ] to [x] in your document. In the desktop app, that change is saved to the file.
  • In many other viewers the boxes are shown but cannot be clicked.

Checkboxes in a table

The task syntax only works at the start of a list item. Inside a table, [ ] shows as plain text. Use a word or a tick symbol instead.

You write

| Task    | Done |
| ------- | :--: |
| Draft   | ✓    |
| Review  |      |

You see

TaskDone
Draft✓
Review

Why a checkbox does not show

  • No space inside the brackets. [] is not a box. Write [ ].
  • No space after the brackets. - [ ]Task does not work. Write - [ ] Task.
  • No list marker. [ ] Task on its own is plain text. Start the line with -.
  • The app does not support task lists. It shows the brackets as text. Most current apps do; some older ones do not.

Questions

How do I make a to do list in Markdown?

Write a list where each item starts with - [ ]. Change [ ] to [x] when an item is done.

Can I count how many tasks are done?

Markdown cannot count them for you. On GitHub, an issue with a task list shows how many tasks are complete in the issue list.

How do I add a checkbox without a bullet?

Markdown needs the list marker. To hide the bullet you would need HTML or custom styles, which most apps do not allow.

Do checkboxes work in Markdown files for AI agents?

Yes. Coding agents often write their plans as task lists in a .md file, and tick the boxes as they work. Open the file in a reader to see progress at a glance.

Next