Markdown editor modal
The editor opens over the issue at full size. It has a Title field, a Templates menu, the formatting toolbar with its Insert menu, and Save and Close buttons. When you edit an existing document, a View / Edit button switches between editing and a read-only preview. Adding uses the heading 'Add Markdown'; editing uses 'Edit markdown: <title>'.
#Worth knowing
Save hands the title and body back to the panel, which writes the .md attachment. Close discards the draft. Save stays disabled until the document has some text in it.
#Where to find it
Issue view > Markdown panel > Add or Edit
#When it opens
The editor opens in live mode, with the Markdown source and the preview side by side, both for a new document and for one you are editing.
#Where you do it
Task | Where |
|---|---|
Add a Markdown document to an issue | Issue view > Markdown panel > Add |
Edit a Markdown document | Issue view > Markdown panel > Edit |
Start from a template | Editor > Templates |
#Settings that affect this
Setting | Where | What it does |
|---|---|---|
Title | Top of the editor | Up to 50 characters. Becomes the attachment's filename, with .md added. A new document saved with no title is called 'Markdown' plus a number. |
View / Edit | Bottom left of the editor, existing documents only | Switches between editing and a read-only preview. Save only shows while you are editing. |
#A few things that catch people out
Choosing a template replaces the title and everything you have already typed.
Relative image paths, such as
./diagram.png, do not resolve in Jira. Use a full web address.There is no image upload from the editor. Images must be referenced by URL.
Saving an edit replaces the attachment: the old .md file is deleted and a new one uploaded.
Deleting a Markdown tab permanently deletes the underlying Jira attachment.
#Related
How it actually behaves.
