22 posts tagged with "markdown"

Inline code — monospace text on a subtle background — is how you mark up variable names, file paths, key names, and short commands inside a sentence: set MAX_RETRIES = 3, edit ~/.zshrc, or run kubectl get pods. Confluence Cloud has three ways to produce it, and each fits a different moment: formatting as you go, typing Markdown, or bringing Markdown in from your repo.

The diagrams live in the repository. They were written in Mermaid, they are reviewed in pull requests next to the code they describe, and they are correct as of the last commit. The documentation, however, lives in Confluence — because that is where the rest of the team reads it. So somebody copies a Markdown file across, pastes it into a Confluence page, and the flowcharts, sequence diagrams and ER models arrive as grey boxes of unrendered code.

Everyone has hit this. It is one of the most common Confluence complaints, and the usual workarounds are worse than the problem: export every diagram to PNG and re-upload them (now they rot), keep the diagrams in an external tool and paste links (readers need a second account, and the links break), or build a browser extension to force rendering on paste.

There is a better answer, and Mermaid 12 makes it better still.

Every team has Markdown lying around that Confluence needs: the README that became the service doc, the design doc drafted as a pull-request description, the runbook that lives in the repo. And every attempt to move it hits the same wall — Confluence's default editor does not parse Markdown. Paste a .md document and you get a wall of pipes, backticks, and asterisks that looks exactly like what it is: text nobody formatted.

The macro route dissolves the wall. Paste the document into a Markdown macro that actually parses it, watch it render in the preview pane, publish. This page is the workflow, end to end.

Every engineering page in Confluence eventually holds code — a curl from the runbook, the config that fixed the incident, the query the dashboard runs. And every one of those snippets has three natural enemies: the language dropdown in the macro dialog, the paste that loses its indentation, and the reader who cannot copy the thing without dragging across line numbers.

Markdown fences solve all three, because they make the code block text you type instead of an object you configure. ```bash, paste, ``` — done, highlighted, copyable. This guide shows the syntax, the theming behavior, and when fences beat the native macro.

Ask an engineer to document an algorithm in Confluence and watch what happens to the math: O(n log n) typed as plain text, x² pasted from a character map, and — for anything real — a screenshot from an online equation editor, blurry and already out of date. Confluence has no native LaTeX support, so every formula becomes either a compromise or an image.

It does not have to. With a Markdown macro on the page, Confluence renders real LaTeX — inline $...$, display $$...$$, fenced blocks with full align environments — and the equation stays text: searchable, theme-consistent, editable in seconds. This guide gives you the syntax and copy-paste examples for all three routes.

Meeting notes fail in one of two directions: they are so informal that nobody can find the decision a month later, or so formal that nobody takes them at all. The Confluence editor quietly encourages the second — formatting dialogs are the enemy of live note-taking.

Markdown flips it. In a split-pane editor, notes are keystrokes: two characters for a heading, pipes for a table row, backticks for a snippet — and the rendered page assembles itself in the right pane while you type. This guide ships the template and the habits that make notes pages worth opening later.

The use case diagram is the scope picture: actors on the outside, what the system does for them on the inside, and — the reason product and engineering fight — the line between them. In Confluence that picture usually comes from a diagramming tool export that goes stale the moment scope moves.

Mermaid 12 added the syntax to render UML use case diagrams from text — usecase-beta — and Enhanced Markdown for Confluence renders it in the same macro as everything else on the page. This guide gives you the syntax and two copy-paste diagrams.

Sequence diagrams die in Confluence in one of two ways: someone draws one in a diagramming tool, exports a PNG, pastes it into a page — and three sprints later the flow has changed but the image has not. Or someone writes the flow as prose ("the client calls the order service, and if payment is approved…"), which is accurate but impossible to read under time pressure.

ZenUML splits the difference: the diagram is code, so it edits like code and renders like a diagram — branches, error paths, and parallel work included. This guide shows the syntax with copy-paste examples you can drop into Confluence today.

Meeting notes, project briefs, planning docs — most Confluence pages already start life as a Markdown-ish outline: a title, some headings, bullets underneath. A mind map is just that outline seen from above. This guide shows how to get from the outline you already have to an interactive mind map on the page, without drawing anything and without learning diagram syntax.

In 2004, John Gruber released Markdown with a modest pitch: a text format that is easy to read, easy to write, and converts cleanly to HTML. Twenty years later his side project became the default language of technical documentation — GitHub renders it natively, Stack Overflow is built on it, Obsidian and Notion popularized it, and every major LLM speaks it fluently. The Verge called it "the default language of the AI era."

That last part is the interesting one. Markdown didn't just survive the AI transition — it locked in because of it. This article walks through why, and what it means for how your team should write documentation inside Confluence.