Formatting

Text format can be used in the Checklist Editor, Checklist Text custom field as well as the new item input field.

 

Checklist Formatting

Checklist Items

A checklist item line can start directly with item text or Markdown characters like the including:

* - + []

1 2 3 4 5 6 checklist item [] checklist item * checklist item * [] checklist item - checklist item - [] checklist item

Checked Items

Checked items are indicated by [x]

1 2 3 [x] checklist item * [x] checklist item - [x] checklist item

Statuses

Statuses are written in square brackets

1 2 3 4 5 [] 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

1 2 3 4 5 6 ? checklist item []? checklist item *? checklist item * []? checklist item -? checklist item - []? checklist item

Item Descriptions

Descriptions are indicated by double arrows >>

1 2 3 4 [] 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

Headers / Separators

You can use Headers to organize long checklists. Headers are proceeded by three dashes ---

1 2 3 4 --- Acceptance Criteria Header - checklist item 1 - checklist item 2 with **bold** text - checklist item 3 with link to an issue IC-245

Additional Elements

Dates

Dates can be included in multiple formats.

Type  // (double slash) to open a calendar picker.

1 2 3 4 [] Due on 2022-05-18 [] Due on 2022/05/18 [] Due on 18-05-2022 [] Due on 18/05/2022

Emojis

Type a colon : to open the emoji menu

1 * [open] Smile 😀

Issue Keys

To reference another issue, type the issue key

1 * [open] See the comment on CSP-61

URLs

URLs can be added in and will be rendered as clickable links

1 2 * [open] https://marketplace.atlassian.com * [open] marketplace.atlassian.com

User Mentions

Typing an @ will open a user picker

1 * [open] Task one @JenniferChoban

Markdown Formatting

Bold

To bold text, add two asterisks, or two underscore characters before and after the word or phrase

1 2 This is **bold text** This is __bold text__

Italics

To italicize text, add one asterisk or underscore character before and after a word or phrase

1 2 This is in *italics* This is in _italics_

Strikethrough

To strikethrough text, add two tilde characters before and after a word or phrase

1 This text is ~~wrong~~

Inline Code

To style text as inline code, add back-tick characters before and after a word or phrase

1 This will be shown as `inline code`

Add a URL directly into the text, or enclose the link text in brackets and follow it immediately with the URL in parentheses

1 2 Contact us at https://www.herocoders.com/contact [Contact us](https://www.herocoders.com/contact)

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)

1 2 Contact us at support@herocoders.com. [Contact us](mailto:support@herocoders.com?subject=Issue Checklist questions&body=Email body text)

 

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

Issue Checklist 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.