Frequently asked questions about Markdown in Jira

Short answers to the questions we hear most, each with a link to the page that explains it properly.


#Writing

#How do I use Markdown in a Jira issue?

Open the issue's Markdown panel, click Add, write with the live preview and click Save. See Use Markdown in a Jira issue.

#Where are the documents stored?

Each document is a .md attachment on the issue, so it follows Jira's attachment permissions and shows in the issue's attachments too.

#Can I upload images into a document?

No. Reference images by web address, or use Insert, From web. Relative paths from a repository do not resolve in Jira. See Images in Markdown.

#Which diagram languages are supported?

28, including Mermaid, PlantUML, Graphviz and D2, written as fenced code blocks. See Add a diagram to a Jira issue with Markdown.

#Why did picking a template wipe what I had typed?

Choosing a template replaces the title and the whole body. Pick the template first, then write. See Start a Jira Markdown document from a template.


#Managing and finding

#Does deleting a tab delete the file?

Yes. Deleting a Markdown tab permanently deletes the .md attachment from the issue. See Edit or delete a Markdown document in a Jira issue.

#Why did the tab order change for everyone?

The sort order is saved on the issue, not per person, so whoever last clicked the sort button set it for all.

#Why does the Capable Markdown page show no results?

It lists issues the app has indexed, and an issue is indexed when a .md file is added to or removed from it. Files attached before the app was installed appear once a .md file is next added to or removed from that issue. See Find Markdown documents across Jira projects.


#Access and export

#Why do logged-out viewers see nothing?

The Markdown panel and the global page are shown to logged-in users only. See Logged-out or anonymous viewers see nothing from the app.

#Why is the Markdown missing from a Jira export or PDF?

Jira's export does not include app panels. Download the .md attachments from the issue instead. See Panel content is missing from a Jira export or PDF.

#Can I restrict who can add Markdown?

Not in the app. Anyone who can add attachments to an issue can add a document, so use Jira's attachment permissions. See the troubleshooting page.



Not here? The troubleshooting pages go deeper.