Skip to content
Yamuno
Browse

The Editor

The editor, with code on the left and the diagram on the right

The editor opens in a modal:

  • from + in the Mermaid diagrams section, for a new diagram;
  • from the issue's ••• menu → Add Mermaid diagram, for a new diagram;
  • from Edit in a saved diagram's toolbar;
  • from Linked issues, Child issues or Timeline next to Add diagram, on an issue with no diagrams yet: the editor opens with that diagram already drawn (see From issue).

Writing

  • The code is on the left, with syntax highlighting. The diagram on the right updates as you type; turn off Auto-update for very large diagrams and press ⌘Enter / Ctrl+Enter to update.
  • Templates has 12 starting points: flowchart, sequence, class, state, entity relationship, Gantt, pie chart, mind map, timeline, user journey, Git graph and quadrant.
  • Snippets, below the code, insert common pieces of syntax.
  • Syntax errors show under the preview, while the last good diagram stays on screen.

From issue

From issue, in the editor's top bar, builds a diagram from the issue you opened the editor on. It replaces the code in the editor and names the diagram; edit it like any other, then save.

Choice What it draws
Linked issues The issue, its links labelled the way Jira reads them ("blocks", "relates to"), its parent and its subtasks
Child issues The issue's child issues and the links between them. More than five children stack in a column
Timeline A Gantt chart of the child issues, from their start and due dates, in Done, In progress and To do sections. Children without either date are left out, with a note in the code saying how many

Every box is coloured by its status (To do grey, In progress blue, Done green), the issue you started from has a thicker outline, and clicking a box opens its issue. Only issues you can see are included, up to 100 children.

The diagram is a snapshot: it doesn't change when the issues do. Run From issue again to draw it afresh.

If there's nothing to draw, for example Child issues on an issue without children, the editor says why and starts from the usual example diagram.

Options

The toolbar above the preview sets options that are saved with the diagram:

Option Choices
Theme Match Jira, Mermaid's Default, Neutral, Forest, Dark and Base, and your site's colour themes
Look Classic or Hand-drawn
Direction (flowcharts) Top to bottom, left to right, bottom to top, right to left

Zoom

Pan by dragging, and zoom with the buttons or ⌘/Ctrl + scroll. If you set the zoom yourself, it's saved with the diagram: the issue draws the diagram at that size, and the editor opens at it next time. Click Fit to screen before saving to go back to fitting the column.

Saving

Give the diagram a title and click Save diagram, or press ⌘S / Ctrl+S. You need permission to edit the issue; without it the editor tells you, and Save is off.

An issue can have up to 20 saved diagrams, which together must fit Jira's 32 KB limit for one issue property. If a save would go over it, the editor says so.

Stuck on something this page does not cover? Ask the developers.