24 posts tagged with "mermaid"

Text-based diagramming — writing a few lines of code that render into a diagram — is how modern teams keep diagrams in sync with their documentation. No more drawing boxes by hand in Visio, exporting screenshots, and pasting them into Confluence where they go stale. With text-based diagrams, you edit the source and the diagram redraws instantly.

But there are three major text-based diagramming languages, and they are not interchangeable. Each has different strengths, different syntax, and different ideal use cases. This guide compares Mermaid, PlantUML, and Graphviz so you can choose the right one (or combination) for your Confluence team.

Every team that adopts Jira diagrams hits the same moment: you discover Mermaid supports 29 diagram types, you get excited, and then you realize you have no idea which ones to actually use during a sprint. Most of them never get drawn. The diagrams that earn their keep are the ones that make a standup faster, an onboarding doc clearer, or a ticket unambiguous — and those are a small, repeatable subset.

This post is the workflow guide we wish we'd had: the four diagram types a sprint team actually uses, each with a real scenario and copy-paste syntax you can drop straight into a Jira issue. The full 29-type reference follows, so the same page works as both a sprint playbook and a complete catalog.

The scenario every technical team hits: your engineering docs live in Markdown — READMEs, API references, design docs — and they contain diagrams (Mermaid), equations (LaTeX), and code samples. You paste that Markdown into Confluence, and it falls apart. The Mermaid code blocks render as plain text. The LaTeX equations show as raw $...$ syntax. The code blocks lose their syntax highlighting. Confluence's native editor is WYSIWYG, not Markdown, and the import tools treat Markdown as a one-time conversion rather than something you edit live.

Enhanced Markdown for Confluence solves this with a Markdown editor that renders everything inline — Mermaid diagrams, KaTeX and LaTeX math, syntax-highlighted code, and GitHub-flavored tables — with a live split preview. It runs on the Quikdown engine, so all rendering libraries are bundled locally (no external CDN dependencies, which matters for "Runs on Atlassian" compliance). This guide walks through writing Markdown in Confluence with diagrams, math, and code all rendering live.

Need diagram tools for Confluence without paying for a large team? NGPILOT's three diagramming apps — Mermaid Plus, Excalidraw Plus, and Graphviz Charts — are all free for up to 10 users. This guide compares them so you can pick the right free diagram plugin for your Confluence.

Adding diagrams to Confluence pages helps teams communicate architecture, processes, and workflows visually. This guide covers the three main approaches to creating diagrams in Confluence and helps you choose the right tool for your needs.

No, Confluence does not support Mermaid diagrams natively. There is no built-in macro or feature that renders Mermaid syntax in Confluence pages. To add Mermaid diagrams to Confluence, you need a Marketplace app.

This guide covers how to set up Mermaid in Confluence and which diagram types you can create.

Sequence diagrams are one of the most widely used diagram types in software documentation. They show exactly how participants -- users, services, databases, external APIs -- exchange messages over time. For Confluence teams, embedding sequence diagrams directly on wiki pages means architecture docs, API specifications, and incident post-mortems stay in one place instead of scattered across external tools.

Mermaid's text-based syntax makes sequence diagrams fast to write and easy to update, but the syntax has its own set of rules that can trip you up. This FAQ answers the questions Confluence users ask most often about building sequence diagrams with Mermaid, with expanded explanations, working code examples, and copy-paste templates you can drop straight into a Mermaid Plus macro.

Mermaid supports 29 diagram types — from flowcharts and sequence diagrams to C4 architecture, swimlanes, Gantt charts, ER diagrams, git graphs, and more. With Mermaid Plus for Confluence, all 29 render from plain text inside a single macro. This page is the complete reference: every type, its keyword, its category, when to use it, and worked examples for the ones a software team reaches for most.

If you are deciding which diagram type fits your use case, jump to When to use each Mermaid diagram type. For the quick reference table, see below. For installation and the macro basics, see Create Mermaid diagrams in Confluence.

Mermaid is the most popular text-based diagramming language for technical documentation. One line of code generates a flowchart. A few more produce a sequence diagram, ER diagram, or Gantt chart. Teams using Confluence can embed Mermaid diagrams directly on their pages, keeping diagrams alongside the documentation they illustrate.

Architecture diagrams are the backbone of technical documentation. They show how services communicate, where data flows, and which infrastructure components underpin your system. When a new engineer joins your team, the first thing they look for is an architecture diagram. When something breaks in production, the incident response starts at the same diagram.

Yet many teams store their architecture diagrams in external tools -- draw.io, Lucidchart, or even desktop applications -- detached from the documentation where they matter most. Confluence is where your runbooks live, where architecture decision records are written, and where post-mortem discussions happen. Keeping your architecture diagrams inside Confluence eliminates context-switching and ensures diagrams evolve alongside the written documentation they illustrate.

This guide walks through three ways to create architecture diagrams directly in Confluence, using NGPILOT apps designed for different workflows. Every Mermaid example is copy-paste ready, so you can insert it into a Confluence page and see the result immediately.