Markdown help

The same cheat sheet you find in the app under ?. Everything here converts to Jira without loss.

Text

Headings

One # per level, up to six. Put a space after the #.

You type

# Heading 1

## Heading 2

### Heading 3

You get

Heading 1

Heading 2

Heading 3

Bold

Two asterisks on each side.

You type

**bold**

You get

bold

Italic

One asterisk on each side.

You type

*italic*

You get

italic

Bold and italic

Three asterisks on each side.

You type

***bold and italic***

You get

bold and italic

Strikethrough

Two tildes on each side.

You type

~~strikethrough~~

You get

~~strikethrough~~

Inline code

Backticks around code inside a sentence.

You type

Run `npm test` first

You get

Run npm test first

Link

Text in square brackets, address in parentheses.

You type

[Atlassian](https://www.atlassian.com)

You get

Atlassian

Escaping

A backslash shows the next character as it is.

You type

\*not italic\*

You get

*not italic*

Lists

Bullet list

Start lines with - and a space.

You type

- One
- Two
- Three

You get

One
Two
Three

Numbered list

Start lines with 1. — Jira numbers them for you.

You type

1. First
2. Second
3. Third

You get

First
Second
Third

Nested list

Indent to the text of the item above (Tab does it for you).

You type

- Parent
  - Child
    - Grandchild

You get

Parent
- Child
  - Grandchild

Checklist

- [ ] for open, - [x] for done. Becomes a Jira action item.

You type

- [ ] Open task
- [x] Done task

You get

Open task
Done task

Blocks

Quote

Start the line with >.

You type

> Quoted text

You get

Quoted text

Code block

Three backticks, optionally with a language.

You type

```ts
const answer = 42;
```

You get

const answer = 42;

Table

Pipes between cells, dashes under the header row.

You type

| Name | Status |
| --- | --- |
| Login | Done |
| Logout | Open |

You get

Name	Status
Login	Done
Logout	Open

Horizontal rule

Three dashes on their own line, with blank lines around.

You type

Above

---

Below

You get

Above

Below