Skip to main content

Format a task's description

A long description is easier for a runner and your team to follow when it has some shape: a heading per part, the steps as a list, what done means as a checklist, and error messages or commands as code. The description box formats as you write, and the runner reads the headings, lists and code as you laid them out.

Who can do this: anyone who can create tasks in the project, or edit the task.

  1. On the task board, select New task. To format an existing task, open it and stay on its Task tab.

  2. Find the formatting bar above the description box. Beside the board it shows Bold, Italic, H2, โ€ข List, โ˜‘ Checklist, ๐Ÿ”— Link and โ‹ฏ.

    The formatting bar: Bold, Italic, H2, List, Checklist, Link and the โ‹ฏ button

  3. Select โ‹ฏ (More formatting) for the rest: H1, 1. List, โ (quote), Code, { } (code block) and ๐Ÿ–ผ Image. Select โ‹ฏ again to fold them away.

    The formatting bar opened: Bold, Italic, H1, H2, both lists, Checklist, quote, Code, code block, Link and Image

  4. Select the words to format, then pick a button. A button with nothing selected formats what you type next, or the line the cursor is on for a heading, list, quote or code block. Pick the same button again to take the formatting off.

  5. To add a link, select the words, then ๐Ÿ”— Link. Your browser asks for the Link URL: type or paste the address and confirm. To remove a link, select it, choose ๐Ÿ”— Link and clear the address. A web address you type or paste becomes a link on its own.

  6. Put error messages, file contents and commands in a code block with { }, so they reach the runner exactly as written and spelling checks leave them alone.

  7. Select Save to keep the draft, or Go to save and start it.

Shortcuts while you typeโ€‹

You can format without the bar:

TypeTo get
#, ## and a space at the start of a lineA heading (H1, H2)
- and a spaceA bulleted list
1. and a spaceA numbered list
[ ] and a spaceA checklist item
> and a spaceA quote
Three backticksA code block
Ctrl+B or Ctrl+I (โŒ˜+B or โŒ˜+I on a Mac)Bold or italic

Text you paste that's already written in Markdown, such as a spec from your notes app or a code host, keeps its headings, lists, links and code. HTML tags you paste as text show as plain text.