Integration

Markdown for Jira is built on parts of Jira you already use: the issue view, attachments and search. Your documents are ordinary .md attachments on the issue, and the app adds a panel, a page and a search index on top of them.

This page lists every connection, so you know what you can rely on and where to stop looking.


#Inside Jira

Jira part

What Markdown for Jira does with it

Issue view

Adds the Markdown panel: one tab per Markdown document on the issue, a rendered preview, and Add, Edit, delete and sort controls. Shown to logged-in users only.

Attachments

Each document is saved as a .md attachment named after its title. A .md file attached through Jira's own attachment control also appears as a tab, without reloading the issue. Deleting a tab deletes the attachment.

Permissions

The panel reads and writes as you, so Jira's browse and attachment permissions decide who can see, add, edit and delete documents. The app has no permission settings of its own.

Search (JQL)

Keeps two searchable values on each issue: how many Markdown files it holds and when the newest one was added. See Markdown search index.

Apps menu

Adds the Capable Markdown page, which lists Markdown documents across projects. Clicking a row opens the issue in Jira's own issue dialog.

Issue properties

Saves the panel's tab order on the issue, so everyone who opens that issue sees the same order.


#Capable services it uses

Service

What you get

Diagram rendering

Fenced code blocks written in a diagram language, such as Mermaid, PlantUML, Graphviz or D2, are drawn as images by Capable's hosted rendering service. See Diagrams in fenced code blocks.

Image proxy

Images referenced by web address are loaded through Capable, so they can display inside Jira. See Images in Markdown.

Templates

The editor's Templates menu offers the same built-in templates as Capable Markdown for Confluence. See Templates.


#What it does not connect to

Product

What that means

Capable Markdown for Confluence

A separate app. Documents in Jira issues do not appear in Confluence, and the Confluence Markdown macros are not available in Jira.

Other Capable apps for Jira

Markdown for Jira does not need, or share data with, any other Capable app. Diagram code blocks render without Capable Diagrams installed.

Jira dashboards

There is no Markdown dashboard gadget.

Rovo

Markdown for Jira adds no Rovo agents or actions.

Jira exports and PDFs

Jira's exports do not include app panels. Download the .md attachments from the issue instead.


#A few things that catch people out

  • JQL search and the Capable Markdown page only know about .md files added or removed while the app is installed and licensed. An older file is picked up the next time a .md file is added to or removed from that issue.

  • Saving an edit replaces the attachment: the old file is deleted and a new one uploaded. People need permission to delete attachments as well as add them, or the old file stays alongside the new one.

  • Logged-out and anonymous viewers see nothing from the app, because the panel and the page are shown to logged-in users only.



Better with company.