Documentation
Everything Vellnar Diagrams does, one task per section, in the order you meet it.
Last updated
Add a diagram to a page
- Edit a Confluence page and type
/mermaidwhere the diagram should go. - Select Mermaid diagram. The editor opens with the template list.
Pick a template, or choose Start blank and type your own code. Then choose Save: the diagram appears on the page.
To change it later, edit the page, select the diagram and open the editor from the macro toolbar.
Start from a template
The Templates button opens 72 starting points for real documents: runbooks, architecture decision records, post-mortems, release plans and more. They are grouped by diagram type in five groups, from Core engineering to Analysis, UX & strategy.
- Search by name, type or document, for example “runbook”.
- Pick a diagram type to see only its templates. Select a template to see its preview and how many lines of code it has.
- Choose Use template. If the editor already holds a diagram, the app asks before it replaces it.
Write and edit the code
The editor shows the Mermaid code on the left and the preview on the right. The preview follows every keystroke.
- The code. Hide code in the top left corner gives the whole window to the preview; the divider between the panels can be dragged.
- Templates opens the template gallery.
- Save puts the diagram on the page. Cancel closes the editor without saving.
- Diagram settings, export and help.
- Zoom, fit, change direction, search and meeting mode.
When a line has an error
- The editor marks the line with the error.
- The message names the line and what Mermaid expected. Copy details for support copies the error and your code, ready to paste into a support request.
- The preview keeps the last valid diagram until you fix the line.
Search the code and the diagram
- Type in Search code and diagram, or press ⌘F (Ctrl F on Windows and Linux).
- The matches light up in the code and in the diagram at the same time. Enter goes to the next match.
Press R on the preview to change the direction of a flowchart, state, class or ER diagram, for example from left-right to top-down.
The app draws more than 30 diagram types with Mermaid 12.3, among them flowcharts, sequence, class, state and ER diagrams, Gantt charts, mind maps, timelines, C4, architecture, Sankey and Wardley maps. The Mermaid documentation describes the syntax of each type.
Diagram settings
Open Diagram settings in the editor to change how the diagram looks and sits on the page.
- The Diagram settings button.
- The settings, described below.
- Theme: Default, Neutral, Forest or Mermaid classic. Colors written in the code stay as they are; Why do some colors stay the same? lists those lines. Every theme follows the light or dark mode of Confluence.
- Look: Classic for clean lines, Hand-drawn for drafts and workshops.
- Alignment: Center or Left, for diagrams narrower than the page.
- Size: Fit width shrinks wide diagrams to the page; Actual size keeps them readable and lets them scroll sideways.
- PDF size: One page puts the whole diagram on one page; Actual size keeps it readable at 100% and may span several pages.
Version history
Every save keeps the earlier code.
- Select the edit status next to the title, for example Edited 2 hours ago, to open Version history.
- Select a version to see its preview.
- Restore this version puts it in the editor. Nothing is saved until you choose Save.
The app keeps the last ten saved versions, the current one included, up to about 200 KB of code in total.
Find diagrams with Confluence search
The words in the diagram code are indexed with the page. Search Confluence for a service, a table or any label and the page with the diagram appears in the results. A change becomes searchable after the page is saved again.
View, present and export
On the page, two buttons appear next to the diagram when you move the pointer over it.
- The top button is Open fullscreen, also ⌘↵ (Ctrl ↵ on Windows and Linux). The one below is Export, the same menu as in the editor.
- Zoom, fit to screen, search and meeting mode.
- Export and help.
The ✕ in the top right corner, or Esc, closes the full screen view.
- In full screen, drag or use the arrow keys to move, plus and minus to zoom, 0 or Space to fit, 1 for actual size and F to search the labels.
- Meeting mode (M) turns the pointer into a laser pointer for presentations.
- Export downloads the diagram as SVG (vector) or PNG (high resolution), or copies it as an image, as SVG code or as Mermaid code. The same menu is in the editor:
- The Export button.
- Download as SVG or PNG, or copy as an image, as Mermaid code or as SVG code.
PDF and Word exports
When Confluence exports the page to PDF, the diagram is a sharp vector picture, sized by the PDF size setting. Word cannot show these pictures, so a Word export contains the diagram code instead. A very large diagram may be too large for a picture in exports; the editor warns you before saving, and the export then shows the code.
Keyboard shortcuts
Press ? in the editor or in full screen to see every shortcut.
The most used:
| Action | Shortcut |
|---|---|
| Save | ⌘S / Ctrl S |
| Find in code and diagram | ⌘F / Ctrl F |
| Show or hide the code | ⌘B / Ctrl B |
| Open full screen from the page | ⌘↵ / Ctrl ↵ |
| Zoom in, zoom out | + and − |
| Fit to screen | 0 or Space |
| Zoom to 100% | 1 |
| Search in diagram | F |
| Change the diagram direction | R |
| Meeting mode | M |
Limits
- A diagram can have up to 100,000 characters of code and 500 connections. Near the limit the editor shows the count; above it, split the diagram into smaller ones.
License
Atlassian sells the app with a 30-day free trial. If the license ends, every diagram stays visible on its page and can still be opened in full screen and exported; only editing pauses. The editor then offers Copy a message for your admin, a ready text that asks a Confluence admin to renew the license.
Permissions and data
The app asks for no permissions and keeps each diagram inside its page. Details on the security and privacy pages.