Common tasks
Rather than a tour, this is the list of things people do, with the route to each.
#What you can do
Task | Where | Notes |
|---|---|---|
Install the app and approve its permissions | Atlassian Marketplace | Needs a Jira administrator. Search and the Capable Markdown page start recording .md files from this point on. |
Check the licence is active | Jira > Apps > Manage apps | Needs a Jira administrator. While the app is unlicensed, new .md files are not recorded for search. |
Make the Markdown panel always visible on issues | Jira project settings > Issue layout | Until then, open the panel on an issue from the apps button under the issue summary. |
Add a Markdown document to an issue | Issue view > Markdown panel > Add | On an issue with no documents yet, the button reads Add Markdown. Save writes a .md attachment named after the title. |
Read a Markdown document | Issue view > Markdown panel | Click a tab to switch documents. Extra tabs collapse into a More menu. The preview is read-only. |
Edit a Markdown document | Issue view > Markdown panel > Edit | Edits the selected tab. Saving replaces the attachment with a new one. |
Delete a Markdown document | Issue view > Markdown panel > Delete icon on the tab | The icon shows when you hover over the tab. Deleting removes the .md attachment for good. |
Change the tab order | Issue view > Markdown panel > sort button | Switches between newest first and A to Z. Saved on the issue, so it changes the order for everyone. Hidden on narrow screens. |
Add a diagram | Editor > Insert > From code, or write a fenced code block yourself | From code starts a Mermaid diagram. PlantUML, Graphviz, D2 and other languages work too, and render as images while you are signed in. |
Add an image | Editor > Insert > From web, or Markdown image syntax with a web address | There is no upload. Use a full web address; relative paths do not resolve in Jira. |
Browse Markdown across projects | Jira > Apps > Capable Markdown | Filter by project. Click a row to open the issue. |
Find issues that contain Markdown with JQL | Jira issue search | Search on the app's |
Share or export a document | Jira's own attachments area on the issue | Download the .md file. Jira's exports and PDFs do not include the Markdown panel. |
Get help | Apps > Capable Markdown > Getting started | Shows short help cards and a View full documentation button that opens this help site. |
#A few things worth knowing
Installing the app and checking its licence need a Jira administrator. Everything else works with ordinary Jira permissions.
Who can add, edit and delete documents follows Jira's attachment permissions on the issue. The app has no permission settings of its own.
JQL search and the Capable Markdown page only see .md files added or removed since the app was installed and licensed.
#Related
What people actually do.
