Lists (markdown)

Definition Lists

Checklists

Rows start with asterisks (*), plus (+) or minus (-) are translated into unordered lists.

For a numbered list, start a row with a number, period (.) and a space.

To create a paragraph under each list, insert 4 spaces.

 

Example 

* Item 1
* Item 2
* Item 3
    * Item 3a
    * Item 3b
    * Item 3c

1. Step 1
2. Step 2
3. Step 3
    1. Step 3a
    2. Step 3b
    3. Step 3c

 

Result

Screenshot_2019-10-09_at_2.54.17_PM.png

 

Definition Lists

Backlog supports definition lists similar to the one supported by PHP Markdown Extra.

A row of terms followed by rows with colons (:) and the definition of that term translates into a definition list.

One term can have multiple definitions associated with it.

Example

Apple
: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.

Orange
: The fruit of an evergreen tree of the genus Citrus.

 

Result

Screenshot_2019-10-09_at_2.58.38_PM.png

 

Checklists

A checklist can be created within issue description only. In your list, add " [ ] "  after the " * " to convert it to a list of checkboxes.

Issues are updated when you (un)select a checkbox.

 

When you type:

* [ ] Item-A
* [x] Item-B
    * [ ] Item-B-1
    * [ ] Item-B-2-a

 

You'll get:

 Screenshot_2019-10-09_at_3.09.27_PM.png

 

Note: Your project will only use Markdown formatting if specified by your administrator under Project Settings. To learn more about this, please read the Formatting Rules.

Was this article helpful?