Tidepool documentation

Tidepool renders Mermaid diagrams in Confluence pages and Jira issues, with a live editor, dark mode and AI drafting. It runs entirely on Atlassian's Forge platform.

Install

  1. A site admin opens Apps › Explore more apps in Confluence or Jira and searches for Tidepool.
  2. Click Get app and start the trial. Sites with up to 10 users are free.
  3. No configuration is needed. Tidepool works for everyone on the site straight away and follows your existing page and issue permissions.

Confluence: add a diagram

  1. Edit a page and type /Tidepool, then choose Tidepool diagram.
  2. The editor opens. Write Mermaid in the Code tab, pick a starting point in Templates, or describe what you want in Prompt.
  3. The preview on the right updates as you type. When it looks right, click Insert and publish the page.
  4. To change a diagram later, edit the page and open the macro again.

If the page already has diagrams from another Mermaid app, the editor offers to bring them into Tidepool so you can keep them after you remove the old app.

Jira: diagrams on an issue

AI drafting

Viewing, export and themes

Supported diagram types

Everything Mermaid supports, including flowchart, sequence, class, state, ER, Gantt, pie, mind map, timeline, journey, git graph, quadrant, sankey, XY chart, block, packet, kanban and architecture diagrams. Templates are provided for the nine most common types.

Licensing

Tidepool is free for sites with up to 10 users and paid per user above that, billed by Atlassian. If a site's license lapses, existing diagrams stay visible but editing and AI drafting pause until the license is renewed.

Limitations

Data and privacy

Tidepool makes no external network requests and stores no personal data. Diagrams live in your Confluence pages and Jira issues. See the privacy policy for details.

Help

Use Report a problem inside Tidepool, open an issue on GitHub, or email support@tidepoolapp.dev. More on the support page.