Issue Checklist for Jira is now Checklist for Jira. New name, same great app. Please go here to see our new documentation site.
Formatting
- Jennifer Choban
Text format can be used in the Checklist Editor, Checklist Text custom field as well as the new item input field.
- 1 Video Tutorial
- 2 Checklist Formatting
- 2.1 Checklist Items
- 2.2 Checked Items
- 2.3 Statuses
- 2.4 Optional Items
- 2.5 Item Descriptions
- 2.6 Headers / Separators
- 3 Additional Elements
- 3.1 Dates
- 3.2 Emojis
- 3.3 Issue Keys
- 3.4 URLs
- 3.5 User Mentions
- 4 Markdown Formatting
- 4.1 Bold
- 4.2 Italics
- 4.3 Strikethrough
- 4.4 Inline Code
- 4.5 Links
- 4.6 Emails
- 4.7 Escaping Markdown Characters
Video Tutorial
Checklist Formatting
Checklist Items | A checklist item line can start directly with item text or Markdown characters like the including: * - + [] | checklist item
[] checklist item
* checklist item
* [] checklist item
- checklist item
- [] checklist item |
Checked Items | Checked items are indicated by [x] | [x] checklist item
* [x] checklist item
- [x] checklist item |
Statuses | Statuses are written in square brackets | [] 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' |
Optional Items | A question mark ? is used to mark items as optional | |
Item Descriptions | Descriptions are indicated by double arrows >> | |
Headers / Separators | You can use Headers to organize long checklists. Headers are proceeded by three dashes --- | Headers must include text. Three dashes that are not followed by text will not be saved/rendered on the checklist UI. |
Additional Elements
Dates | Dates can be included in multiple formats. Type  | Date lozenges are color coded:
 |
Emojis | Type a colon : to open the emoji menu | |
Issue Keys | To reference another issue, type the issue key | |
URLs | URLs can be added in and will be rendered as clickable links | |
User Mentions | Typing an @ will open a user picker |
Markdown Formatting
Bold | To bold text, add two asterisks, or two underscore characters before and after the word or phrase | |
Italics | To italicize text, add one asterisk or underscore character before and after a word or phrase | |
Strikethrough | To strikethrough text, add two tilde characters before and after a word or phrase | |
| To style text as inline code, add back-tick characters before and after a word or phrase | |
Links | Add a URL directly into the text, or enclose the link text in brackets and follow it immediately with the URL in parentheses | |
Emails | Add the email address directly into text, or enclose the link text in brackets follow it immediately with a mailto data (you can specify email subject too) | Â |
Escaping Markdown Characters
To display Markdown formatting characters, use the backslash \ character like demonstrated below
Markdown text | Rendered output |
|---|---|
Escaped \_italic\_ formatting | Escaped _italic_ formatting |
Escaped \_italic_ formatting | Escaped _italic_ formatting |
Escaped \**bold\** formatting | Escaped **bold** formatting |
Escaped \**bold** formatting | Escaped **bold** formatting |
Escaped \*\*bold\*\* formatting | Escaped **bold** formatting |
Escaped \**bold\\** formatting containing backslash | Escaped **bold\** formatting containing backslash |
Escaped \`inline code\` formatting | Escaped `inline code` formatting |
Escaped back-tick \` character | Escaped back-tick ` character |
Standard text with \ backslash | Standard text with \ backslash |
\[In the target instance] | [In the target instance] |
Note that in the Rendered output column:
Formatting is not applied due to backslash \ usageÂ
The backslash \ is not displayed when it is used to escape Markdown
Double backslashes are used to display a single backslash inside a Markdown formatted phrase
The backslash behaves like a normal character when used outside Markdown formatted phrase
Checklist for Jira uses square brackets to represent the state of an item in the text format. Therefore, when you include square brackets at the beginning of a checklist item they are removed. To show brackets in your checklist item, use the \ character prior to the opening bracket.