Documentation
Markdown Live Editor for Confluence
Paste or write Markdown on a Confluence page and see it rendered: live preview while you edit, GitHub-flavored Markdown with highlighted code, tables, task lists, Mermaid diagrams and LaTeX math. The content is indexed by Confluence search and exports as native content.
Get it on the Marketplace Support
Install
- A Confluence site administrator installs the app from the Atlassian Marketplace (Apps → Explore more apps → search “Markdown Live Editor”).
- Open any page in the editor, type
/markdownand choose Markdown. The editor opens with an example document.
Edit
- Write or paste Markdown on the left; the preview on the right updates as you type. Paste from clipboard replaces the content with what you copied.
- Options at the top: Table of contents (built from your headings), Line breaks as in source (a single newline becomes a line break, as in GitHub comments), Show source under the content, Max width and Code size.
- Drag the divider to resize the panes, then Save. To edit later, select the macro on the page and click the pencil.
Supported syntax
| Feature | Syntax |
|---|---|
| Headings, emphasis, lists, quotes, rules, links | Standard Markdown |
| Tables, task lists, strikethrough, autolinks | GitHub-flavored Markdown (| a | b |, - [ ] task, ~~text~~) |
| Code with highlighting | ```js … ``` (40+ languages; a copy button appears on hover) |
| Mermaid diagrams | ```mermaid … ```; double-click a diagram to open it full screen with zoom |
| LaTeX math | $inline$ and $$block$$, rendered with KaTeX |
| Footnotes | text[^1] and [^1]: note |
| Images |  is shown as a link that opens the image in a new tab (see below) |
| Raw HTML | Not interpreted: HTML tags are shown as text |
Links to pages in your Confluence site open in the same tab; other links open in a new tab.
Search
The Markdown you save is added to the Confluence search index. Searching for words or phrases that only exist inside the macro finds the page, and the result shows the matching snippet. New or edited content appears in search within a few minutes.
Exports (PDF and Word)
When a page is exported, the macro converts your Markdown to native Confluence content: headings, bold and italic, lists, task lists, tables, quotes, rules and code blocks. Mermaid diagrams are exported as their source code and formulas as LaTeX text, because exports cannot run the browser code that draws them.
Why images are shown as links
Loading images from external websites would require the app to declare external network access, which removes its Runs on Atlassian status (the guarantee that no data leaves Atlassian). We chose to keep that guarantee: images referenced by URL are shown as a labelled link that opens the image in a new tab. Tell us if you need inline images and we will consider an opt-in option.
Limits
- Up to 100 KiB of Markdown per macro (roughly 15,000 words). Add more macros for longer documents.
- Rendering happens in the web editor and page view; the macro is not available in the Confluence mobile apps.
Where your data lives
The Markdown source and its settings are stored in the macro’s configuration, inside the Confluence page: versioned, copied and exported with the page. The app has no servers, stores nothing elsewhere, reads no other content and sends nothing outside Atlassian. See the privacy policy.
Troubleshooting
| Symptom | What to check |
|---|---|
| A table does not render | GFM tables need a header row and a separator line (|---|---|) with the same number of columns. |
| Single line breaks are ignored | That is standard Markdown. Enable Line breaks as in source or end lines with two spaces. |
| A formula shows as text | Check that the formula is between $ signs without spaces next to them, e.g. $E = mc^2$. |
| Search does not find new text yet | Indexing takes a few minutes after saving. Confirm the page itself appears when searching its title. |
Changelog
- 1.0 — First release: live editor, GitHub-flavored Markdown, code highlighting, Mermaid, LaTeX, search indexing, native exports, light and dark mode.