How to convert Markdown to Jira
Jira Server, Data Center and the older Jira text fields do not read Markdown. They read their own wiki markup, where a heading is h2. Title, bold is *text* and a code block sits between {code} tags. A markdown to jira converter rewrites one syntax into the other so you can keep writing in Markdown and paste the result.
This page reads your Markdown into a tree of headings, paragraphs, lists, tables and code blocks first, then writes each part in wiki markup. Because it works on the tree and not on search-and-replace rules, nested lists, a pipe inside a table cell and a star inside a code block come out right.
Everything runs in your browser. The text is not sent to a server. See the Privacy Policy for the details.
What each part becomes
- Headings:
## Titlebecomesh2. Title. Levels 1 to 6 are kept. - Bold, italic, strikethrough and inline code:
**a**becomes*a*,*a*becomes_a_,~~a~~becomes-a-and`a`becomes{{a}}. - Links and images: a link with text and an address is written with a pipe between them, inside square brackets. An image becomes
!pic.png|alt=alt text!. - Lists: each level adds one marker, so a bullet inside a numbered item is
#*. Task items become [x] and [ ] text. - Tables: the first row is written with
||separators and the rest with|. - Quotes and rules: a block quote is wrapped in
{quote}and a horizontal rule is----.
A worked example
This Markdown has a heading, a nested list, a table and a TypeScript block:
### Steps to reproduce
1. Choose a new password
- at least 12 characters
2. Sign in again
| Browser | Fails |
|:--|:-:|
| Chrome | yes |
```ts
const ttl = 3600;
```The converter writes this Jira wiki markup. The table alignment is dropped and ts is renamed to javascript, and the panel tells you about both:
h3. Steps to reproduce
# Choose a new password
#* at least 12 characters
# Sign in again
||Browser||Fails||
|Chrome|yes|
{code:javascript}
const ttl = 3600;
{code}Markdown to Jira table
A markdown to jira table needs two changes. Jira marks header cells with double pipes, and it has no column alignment, so the colons in the divider row of a Markdown table have no place to go. The tool writes the first row as ||Name||Qty||, writes the other rows with single pipes and counts the tables whose alignment it dropped.
A pipe inside a cell is escaped as \| so it does not split the cell. Turn Table header row off if you want every row written as a normal row. To build the Markdown table from a spreadsheet first, use CSV to Markdown.
Code blocks and languages
Jira colors code only for a fixed list of languages, among them java, javascript, json, python, bash, sql, xml, yaml, php and go. Common Markdown names are renamed: ts and tsx become javascript, sh and zsh become bash, yml becomes yaml. A language Jira does not know, such as rust, is written as a plain {code} block and listed in the notes so you are not surprised by missing colors.
Choose {noformat} instead if you want a grey monospace box with no coloring at all. The code itself is never changed, so a star or a brace inside it stays as written.
What Jira cannot show
Some Markdown has no wiki markup counterpart. Raw HTML, footnotes and math blocks are the usual ones. The tool does not delete them and does not guess. It leaves the text in place and lists each line in the Not converted panel with its line number, so you can rewrite those lines before you paste.
Emphasis inside a word, such as un**believ**able, cannot be written because Jira only starts bold after a space or a symbol. A block inside a list item, such as a code block, is written on its own lines and can split the list in Jira.
Jira Cloud and the new editor
The newer Jira Cloud editor accepts Markdown shortcuts as you type and converts pasted Markdown on its own, so you may not need this tool there. The wiki markup it writes is for Jira Server, Data Center, older Cloud fields, Confluence legacy pages and any field switched to the Text tab. If you need the other direction, Jira to Markdown turns wiki markup back into Markdown.
If you only need plain words from Markdown, Markdown to Text removes the syntax, and Markdown to Rich Text makes a formatted copy for editors that accept pasted rich text.