
Documentation
Mermaid Diagram for ConfluenceBrowse
Documentation
Mermaid Diagram for ConfluenceRelease Notes
Version 3.4: know when a repository diagram is out of date
- Linked diagram check: once a week the app checks diagrams linked to a file on GitHub, GitLab or Bitbucket. Ones whose file has a newer version are listed on the usage page, and editors see a dot on the file name in the editor. Admins can run it now from Settings → Repositories. See When the file changes.
- Settings → Repositories: a tab for each of GitHub, GitLab and Bitbucket, and each connection lists the repositories it can reach.
- Settings: the Sources tab is now Import from URL.
- Fix: Themes in the editor's settings menu opens the right settings page.
Version 3.3: a usage page
- Usage: a Mermaid Diagrams page in Confluence's Apps menu, for everyone: pages with diagrams, spaces, when diagrams last changed (daily, weekly or monthly) and recently updated pages, plus a searchable list of every page with a diagram. It replaces the Usage tab in settings. See Usage.
Version 3.1
- GitLab and Bitbucket: Insert → From GitLab and From Bitbucket import a
.mmdfile or a Mermaid block from a Markdown file, including from private repositories, and keep the diagram linked: refresh it, or commit changes back. Admins connect them in Settings → Repositories with an access token (gitlab.com and self-managed GitLab, Bitbucket Cloud). See GitHub, GitLab and Bitbucket. - Import from a URL: Insert → From a URL loads a public
.mmdor Markdown file. Links to a file on GitHub, GitLab or Bitbucket work too. Admins choose the allowed sites in Settings → Sources. See Import from a URL. - Settings: the GitHub tab is now Repositories, with GitHub, GitLab and Bitbucket together, and there's a new Sources tab.
Version 3.0
- GitHub: Insert → From GitHub imports a
.mmdfile or a Mermaid block from a Markdown file, including from private repositories. The diagram stays linked to its file: Refresh from GitHub, or Commit to GitHub (only that block is replaced in Markdown files, and a file that changed on GitHub is never overwritten). - Connect GitHub: one click in Settings → GitHub creates a private GitHub App in your own organization. Yamuno doesn't run a GitHub App or hold your keys.
- Upgrade: this version asks a site admin to approve the upgrade, because admins can now let the app reach GitHub. It reaches nothing outside Atlassian until an admin connects it.
Version 2.0 — Mermaid Diagram for Confluence
- Editor: split code and live preview, snippets, pan, zoom, fit and full screen; the zoom you set is kept on the published page.
- 12 templates: flowchart, sequence, class, state, entity relationship, Gantt, pie, mind map, timeline, user journey, Git graph and quadrant.
- Page tree: a diagram of a page and the pages under it, as a flowchart or a mind map, up to all levels, with every box linked to its page.
- Links to pages: right-click a flowchart box to make it open a Confluence page.
- Colour themes: site-wide themes with generated or hand-picked dark-mode versions, managed by admins.
- Diagram options: theme, hand-drawn look and direction from the canvas toolbar.
- Published diagrams: zoom, full screen, code view and high-resolution PNG download, in light and dark mode.
- Usage: every page that contains a diagram, with search; diagrams are found by Confluence search.
- Export: a light-colour image in PDF export and the Mermaid code in Word export.
Compatibility: Confluence Cloud
Stuck on something this page does not cover? Ask the developers.