Text format can be used in the Checklist Editor, Checklist Text custom field as well as the new item input field.
| Table of Contents |
|---|
| maxLevel | 4 |
|---|
| minLevel | 1 |
|---|
| exclude | On this page |
|---|
|
Video Tutorial
...
Checklist Formatting
| Excerpt |
|---|
|
| A checklist item line can start directly with item text orMarkdowncharacters like the including: * - + [] | | Code Block |
|---|
checklist item
[] checklist item
* checklist item
* [] checklist item
- checklist item
- [] checklist item |
| | Checked items are indicated by [x] | | Code Block |
|---|
[x] checklist item
* [x] checklist item
- [x] checklist item |
| | Statuses are written in square brackets | | Code Block |
|---|
[] Open item
[open] Another open item
[in progress] Item with status 'in progress' which is still unchecked
[done] Completed/checked item with status 'done'
[skipped] Completed/checked item with status 'skipped' |
| | A question mark ? is used to markitems as optional | | Code Block |
|---|
? checklist item
[]? checklist item
*? checklist item
* []? checklist item
-? checklist item
- []? checklist item |
| | Descriptions are indicated by double arrows >> | | Code Block |
|---|
[] Unchecked checklist item with description
>> Description text can be long and multiline.
>> It can contain links, mentions, dates, and other formatting elements.
[x] Checked item without description |
| | You can use Headers to organize long checklists. Headers are proceeded by three dashes --- | | Code Block |
|---|
--- Acceptance Criteria Header
- checklist item 1
- checklist item 2 with **bold** text
- checklist item 3 with link to an issue IC-245 |
| Note |
|---|
Headers must include text. Three dashes that are not followed by text will not be saved/rendered on the checklist UI. |
|
|
Additional Elements
| Excerpt |
|---|
|
| Dates can be included in multiple formats. Type // (double slash) to open a calendar picker. | | Code Block |
|---|
[] Due on 2022-05-18
[] Due on 2022/05/18
[] Due on 18-05-2022
[] Due on 18/05/2022 |
| | Type a colon : to open the emoji menu | | Code Block |
|---|
* [open] Smile 😀 |
| | To reference another issue, type the issue key | | Code Block |
|---|
* [open] See the comment on CSP-61 |
| | URLs can be added in and will be rendered as clickable links | | Code Block |
|---|
* [open] https://marketplace.atlassian.com
* [open] marketplace.atlassian.com |
| | Typing an @ will open a user picker | | Code Block |
|---|
* [open] Task one @JenniferChoban |
|
|
...