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

 

* List1

   Paragraph1

   * List2

       Paragraph2

       * List2-1

       * List2-2

           Paragraph2-2

  1. List1
  2. List2
  3. List2-1
  4. List2-1-2
  5. List2-2
  6. List2-2-1
  7. List3
  8. List3-1

Result

 

List1

Paragraph1

List2

Paragraph2

List2-1

List2-2

Paragraph2-2

List1

List2

List2-1

List2-1-1

List2-1-2

List2-2

List2-2-1

List3

List3-1

 

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.

: An American computer company.

 Orange

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

Result

Apple

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

An American computer company.

Orange

The fruit of an evergreen tree of the genus Citrus.

Checklists

In your list, add " [ ] " or " [x] " after the dash 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:

 Screen_Shot_2018-03-12_at_2.50.33_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?