Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a way to use Markdown (or similar) in Jira's text fields?

Tags:

jira

I'm using Jira for issue tracking and would like to be able to write issue descriptions and comments using Markdown. Is there a way to do that? If not Markdown, wiki syntax, Textile, whatever -- just a way to get some mild html formatting into the page.

FWIW, something with a live preview, like SO would be great, but I'm really talking about on the rendering side. (Obviously, I can type all the Markdown I want :)

like image 435
sprugman Avatar asked Aug 09 '11 21:08

sprugman


People also ask

Does Jira accept markdown?

The Atlassian editor supports markdown formatting for rich text fields. This makes it quick and easy to add headings, lists, code blocks, and more to your descriptions, comments, and other rich text fields.

Does confluence support markdown?

Confluence supports inserting content in markdown. This is often used in ReadMe files.

How do I enable wiki markup in Jira?

The macros used by the wiki style renderer can be enabled or disabled as follows. Select > Apps. The 'Find add-ons' screen shows add-ons available via the Atlassian Marketplace. Select Manage Add-ons to view the plugins currently installed on your Jira instance.


3 Answers

There is now an unofficially supported plugin to support just this.

  • Atlassian announcement of markdown support
  • Plugin download page

Now all we need to do is get Atlassian to support it properly (:

like image 101
Jay Avatar answered Oct 20 '22 20:10

Jay


You need to change the field's renderer to 'Wiki Style Renderer'. You can do this by editing the field configuration for your project and click the renderers link next to the field you want to change. You can apply this rendering to both default and custom text fields. Of course, once you switch a field to wiki, you won't be able to go back very easily. Fortunately, this can be configured on a per project basis.

See the following documentation for detailed instructions:

https://confluence.atlassian.com/display/JIRA/Specifying+Field+Behavior

like image 30
codeturner Avatar answered Oct 20 '22 22:10

codeturner


You can use Confluence Wiki syntax in description and comment fields. You'll see a Help icon next to the field when you're in edit mode where you can look at the syntax; there is also a preview button to look at your changes before you save.

like image 2
gareth_bowles Avatar answered Oct 20 '22 20:10

gareth_bowles