To-do

Last updated May 2026

Basic Block

All plans

A checkbox task item. The checked state is stored in block metadata and persists across sessions. Completed items render with a strikethrough. Add with /todo or /task.

Markdown shortcuts

Typing [] at the start of an empty block and pressing Spaceor Enter converts the block into a To-do item. The markdown prefix is removed from the block content when converted.

Usage

Click the checkbox to toggle between checked and unchecked. The text editor sits to the right of the checkbox and supports full inline formatting. Checked items automatically apply a line-through style and reduce text opacity to signal completion.

Checked state

The checked boolean is stored in metadata.checked. It is persisted to the Yjs document on every toggle — collaborators see the state update in real time. On the published page, the checkbox renders as a native <input type="checkbox" readOnly /> reflecting the saved state.

ℹ

To-do checkboxes are read-only on published pages. The checked state reflects what was saved in the editor at publish time — visitors cannot check or uncheck items. If you need interactive checkboxes, use a form block or email capture instead.

Keyboard behaviour

Enter

Creates a new to-do block immediately after.

Enter (empty)

Pressing Enter on an empty to-do converts it to a paragraph.

Tab

Increases indent level.

Shift+Tab

Decreases indent level.

Backspace

Deletes the block when the cursor is at the start of an empty item.

checked

Boolean stored in metadata. Toggled by clicking the checkbox.

Text color

When unchecked, the block-level text color applies. When checked, the strikethrough style overrides it.

← PreviousLists Next →Quote