Markdown (issue panel)

Updated
View as text
Open in Confluence
Open in ChatGPT Open in Claude

The main working surface. One tab per .md attachment on the issue (extra tabs collapse into a 'More (n)' menu), a read-only rendered preview of the selected tab, a sort button, Edit and Add buttons, and a Delete icon on each tab with a confirmation dialog. The panel refreshes itself when Jira reports the issue changed, so files attached through Jira's own attachment control appear without a reload.

A Jira work item with the Capable Markdown panel open, showing tabs for User Journey and Architecture Design, a rendered software architecture document, and Edit and Add buttons.
The panel sits below the description on the work item, with one tab for each Markdown document attached to it.

#Worth knowing

The panel reads the issue's attachments directly, so it shows every .md file on the issue, including ones attached before the app was installed.

#Where to find it

Issue view > Markdown panel

Close-up of a Jira work item header with the apps button open and a small menu listing Markdown and Add apps.
The apps button beneath the work item summary lists Markdown, which puts the panel on that work item.

#When there are no documents

The panel reads 'No markdown documents added to this issue' and shows a single Add Markdown button.

#Where you do it

Task

Where

Make the Markdown panel always visible on issues

Jira project settings > Issue layout

Add a Markdown document to an issue

Issue view > Markdown panel > Add

Read a Markdown document

Issue view > Markdown panel

#Settings that affect this

The Markdown panel on a Jira work item with no documents yet, its actions menu open showing Show for all work items, Collapse and Remove.
Choosing 'Show for all work items' from the panel's actions menu makes the panel appear on every work item by default.

Setting

Where

What it does

Sort tabs

Issue view > Markdown panel > sort button

Switches the tabs between newest first and A to Z. The choice is saved on the issue, so everyone sees the same order. The button is hidden on narrow screens.

#A few things that catch people out

  • There is no version history for a Markdown document, neither in Jira nor in the app.

  • Nothing prevents two documents on the same issue having the same title, and renaming makes the old filename disappear.

  • Raw HTML inside a Markdown document is not rendered.

  • Relative image paths, such as ./diagram.png, do not resolve in Jira. Use a full web address.

  • Content that does not look like Markdown can be replaced by an 'Invalid markdown provided' message naming the detected language.

How it actually behaves.