Rule to formatting texts (Markdown)

Headings

Backlog supports 2 types of headings. When = (equal) or - (minus) is added under a row, it will be translated into a heading. The number of = (equal) or - (minus) doesn't matter. Any rows starting with # (hash) will be translated into headings, too.

Example

Heading1
=============

Heading2
-------------

# Heading1

## Heading2

### Heading3

#### Heading4

##### Heading5

###### Heading6

Result

Quotes

Rows starts with > (angle bracket) are converted to quotes.

Example

> This is a quoted sentence.
> This is a quoted sentence.
> This is a quoted sentence.

Result

Lists

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
    1. List2-1
        2. List2-1-2
    1. List2-2
        1. List2-2-1
3. List3
    1. List3-1

Result

Checklist (issue description only)

In your list, add [ ] or [x] after the dash to convert it to a list of check boxes. Issues are updated when you (un)select a check box.

Example

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

Result

Code blocks

When you want to use code blocks, put 4 spaces on the top so that it will be recognized as a code block. When you surround the relevant text with ```, it will be also recognized as a code block. When you want to use the code block style for part of a sentence, surround it with ` . It will be recognized as inline code.

Example

    package helloworld;
    
    public class Hello {
        public static void main(String[] args) {
            System.out.println("Hello World");
        }
    }
```
package helloworld;

public class Hello {
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}
```
`inline code`

Result

Horizontal rules

Rows that contains only three or more - (minus), * (asterisk) or _ (underscore) are translated into horizontal rules.

Example

* * *

***

*****

- - -

---------------------------------------

_ _ _

Result

---

---

---

---

---

---

Links

To translate into links, surround the link text with [] (square brackets) and put the URL in () (round brackets) right after it. On Backlog, URL and email address separated with spaces are automatically translated into links.

Example

This page on [Backlog](https://nulab.com/backlog/) is useful to solve this bug.
This page https://nulab.com/backlog/ is useful to solve this bug.
Send an email to support@nulab.com .

Result

This page on Backlog is useful to solve this bug. This page https://nulab.com/backlog/ is useful to solve this bug. Send an email to support@nulab.com .

Italic, Bold, Strike

Text surrounded with * (asterisk) or _ (underscore) are translated into italics. Enclosed text with ** (two asterisks) or __ (two underscores) are translated into boldface. In addition to the toolbar, you can create a strikethrough by adding ~~ around the desired text.

Example

This is *italics* .
This is _italics_ .
This is **bold** .
This is __bold__ .
This is ~~Strike~~ .

Result

This is italics .

This is italics .

This is bold .

This is bold .

This is Strike .

Images

! (exclamation point), Alt text in [] (square brackets) and the URL in () (round brackets) converts to images.

Example

![Alt text](/path/to/img.jpg)

Result

Tables

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

| (vertical bar) is used to divide cells in a row. By putting || (two vertical bars) without a space in between, the cell on the left will be merged. Multiple - (hyphens) divides header and body rows. Enclosing the hyphens in : (colon) will align text center, and putting : (colon) on the right will align text right. Enclose the title of the table in [] (square brackets) and put it at the last row.

Example

|         | Merge                     ||
| Header1 | Header2      | Header3     |
|-------- |:------------:|------------:|
| Cell1   | Wider cell                ||
| Cell2   | Align center | Align right |
| Cell3   | **Bold**     | *Italic*    |
| Cell4   | More                      ||
[Sample]

Result

Definition lists

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

A row of a term followed by rows with : (colon) and the definition for 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

Escape text formatting

Insert \(¥) before a text to prevent text formatting.

Example

\*Not Striked\*
\\\\Home\hoge\hoge2

Result

*Not Striked*

\\Home\hoge\hoge2

Links to issues and Wikis

To create a link to another issue in the same Space, simply put the issue key or enclose it in double [[]] (square brackets). For the Wiki, the name of the Wiki page needs to be enclosed in double [[]] (square brackets).

Example

This seems to be the same phenomenon as we saw in [[BLG-104]]. 
Please refer BLG-87 also.
Check out [[Home]] at first.

Result

This seems to be the same phenomenon as we saw in BLG-104. Please refer BLG-87 also. Check out Home at first.

Links to Subversion revisions

Insert a link to the Subversion's revision details by putting # (hash), "rev" and revision number enclosed in () (round brackets) together.

Example

#rev(11)

Result

Links to Git revisions

# (hash) with rev(repository:revision) translates into a link to the Git's revision details.

Example

#rev(app:abcdefg)

Result

Links to a file attached on Wiki

You can insert links to the attached files on Wiki. Usually the link is inserted through the toolbar on the Wiki's editing page, so you don't need to memorize this formatting rule.

Example

#attach(sample.zip:11)

Result

Showing attached file image on Wiki

You can insert an image file that has been attached to Wiki. Usually the link is inserted through the toolbar on the Wiki's editing page, so you don't need to memorize this formatting rule.

Example

#image(11)

Result

Table of contents

By typing "toc" enclosed in [] (square brackets), Backlog searches for headings and then inserts the table of contents.

Example

[toc]
    
# Heading1
## Heading1-1
## Heading1-2
# Heading2
## Heading2-1
### Heading2-1-1

Result

Differences from standard Markdown

Paragraphs and line breaks

With Markdown in general, one or more consecutive sentences without indents become a paragraph and one or more blank lines separate paragraphs. With standard Markdown, line breaks within a paragraph are ignored but they will be shown on Backlog.

HTML tags

With standard Markdown, HTML tags are supported but they will be ignored on Backlog due to security concerns.

Extensions

In addition to standard Markdown, Backlog supports the following formatting rules.

• Tables
• Definition lists
• Links to issues and Wikis
• Links to Subversion revisions
• Links to Git revisions
• Links to a file attached on Wiki
• Showing attached file image on Wiki
• Table of contents