Jira Description Markdown

Posted on  by admin

Easily embed different kind of charts and diagrams to your Jira issues!

Use markdown in jira

Checklist for Jira - Server & Data Center Docs. Users can format their checklists using the full Markdown suite. Learn the basics on how to using Jira as a developer, including how to join your team’s projects, create new issues, and organize work. JIRA Agile Essentials: Bring the power of Agile to Atlassian JIRA and run your projects efficiently with Scrum and Kanban Patrick Li download Z-Library. Download books for free.

Mermaid Charts & Diagrams for Jira provides an app that allows you to add beautiful diagrams define with a textual descriptions. A documentation of the textual description can be found here https://mermaid-js.github.io/mermaid.

Jira Description Markdown Examples



Jira Description Field

  • Supports various diagrams such as flow charts, sequence diagrams, class diagrams, state diagrams, entity relationship diagrams, gantt diagrams, pie charts, git graphs and user journey diagrams


I was able to implement/use the JIRA REST v3 api, it’s pretty straightforward to create Issues through the API: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-post

The problem is that by default we can create only text based descriptions.
I noticed JIRA has it’s own rich text / mark down structured text format (ADF = Atlassian Document Format).
Since we’re using HTML in our client, we need to find a way convert HTML to JIRA “rich text” (ADF). Is there an API or a library to make this happen?

Jira Description Markdown

OR can JIRA api interpret standard Markdown as description?

Jira Description Markdown

Jira Description Markdown Template

What is the best way to do such a conversion?
Please advise.