# Enhanced Markdown for Confluence — User Guide

## Overview[​](#overview "Direct link to Overview")

Enhanced Markdown for Confluence brings a fast, lightweight Markdown editor to your Confluence pages. Write in Markdown with a live split preview, syntax-highlighted code blocks, Mermaid and ZenUML diagrams, KaTeX and MathJax math, GitHub-flavored tables, and bidirectional scroll sync between source and preview.

The editor runs on the [Quikdown](https://github.com/deftio/quikdown) engine — small bundle, no cluttered toolbar, all rendering libraries bundled locally so it works reliably inside Confluence without external CDN dependencies.

## Getting Started[​](#getting-started "Direct link to Getting Started")

### Inserting a Markdown Block[​](#inserting-a-markdown-block "Direct link to Inserting a Markdown Block")

1. Edit a Confluence page
2. Type `/enhanced markdown` in the editor and select **Enhanced Markdown for Confluence**
3. The editor opens where you can compose your Markdown content
4. Write, paste, or upload a `.md` file
5. Click **Save** to render it on the page

### Re-editing[​](#re-editing "Direct link to Re-editing")

Click on an existing Enhanced Markdown macro and select **Edit** to reopen the editor. Your Markdown source is preserved across edits — content is stored compressed, and existing macros continue to render without migration.

***

## Features[​](#features "Direct link to Features")

### Three View Modes[​](#three-view-modes "Direct link to Three View Modes")

Pick a mode from the header to match how you want to work:

* **Source** — full-width Markdown editing
* **Split** — source on the left, rendered preview on the right (default)
* **Preview** — full-width rendered preview, no editing chrome

Your choice is saved per macro — reopen the editor and the same mode comes back.

### Live Preview with Scroll Sync[​](#live-preview-with-scroll-sync "Direct link to Live Preview with Scroll Sync")

In **Split** mode, scrolling one pane moves the other proportionally. Scroll the source and the preview follows; scroll the preview and the source follows. Sync is bidirectional and avoids feedback loops, so long documents stay easy to navigate.

### Code Syntax Highlighting[​](#code-syntax-highlighting "Direct link to Code Syntax Highlighting")

Fenced code blocks are highlighted automatically across 190+ languages via highlight.js, with GitHub light and dark themes that match Confluence's color scheme.

````
```python

def greet(name):

    return f"Hello, {name}!"

```
````

````
```bash

pnpm install && forge deploy
````

`````


### Mermaid Diagrams



Render flowcharts, sequence diagrams, Gantt charts, class diagrams, state diagrams, ER diagrams, pie charts, journey maps, and more.



````md

```mermaid

graph LR

  A[Write] -->|preview| B[Review]

  B --> C{Looks good?}

  C -->|yes| D[Publish]

  C -->|no| A
`````

`````


### ZenUML Sequence Diagrams



Use ZenUML's modern `Actor->Message` syntax for sequence diagrams.



````md

```zenuml

participant User

participant Editor

User->Editor: type markdown

Editor-->User: live preview

```
`````

### Math — KaTeX and MathJax[​](#math--katex-and-mathjax "Direct link to Math — KaTeX and MathJax")

Render math three ways:

* **KaTeX fences** for fast CSS-based rendering:

  ````
  ```katex

  E = mc^2

  ```
  ````

* **MathJax fences** (`math`, `tex`, or `latex`) for full LaTeX including `\begin{align}` and AMS packages:

  ````
  ```math

  \begin{align}

  \nabla \times \vec{B} &= \mu_0 \vec{J}

  \end{align}

  ```
  ````

* **Inline math** with `$...$` and display math with `$$...$$`, typeset in both source and preview:

  ```
  Euler's identity $e^{i\pi} + 1 = 0$ appears mid-sentence.
  ```

MathJax is bundled locally — no CDN egress required by the macro.

### GitHub-Flavored Tables[​](#github-flavored-tables "Direct link to GitHub-Flavored Tables")

Standard pipe tables render with column alignment:

```
| Feature       | Status |

| ------------- | :----: |

| Split editor  |   ✅   |

| Scroll sync   |   ✅   |
```

### Upload a Markdown File[​](#upload-a-markdown-file "Direct link to Upload a Markdown File")

Click **Upload MD** in the header to import an existing `.md` or `.markdown` file directly into the editor. Useful for migrating notes from another system or pasting in a doc that lives outside Confluence.

### Dark Mode[​](#dark-mode "Direct link to Dark Mode")

The editor and rendered output follow Confluence's theme automatically — code highlighting, diagrams, and math all switch palettes with the host page. No toggle needed.

### Smart Links[​](#smart-links "Direct link to Smart Links")

Links inside the macro behave the way you'd expect:

* **In-page anchors** (`#section`) scroll within the macro instead of navigating away
* **Path-rooted links** (`/wiki/download/...`) open correctly through Confluence rather than 404'ing inside the iframe
* **External links** open in a host-controlled tab

***

## Tips[​](#tips "Direct link to Tips")

* Use **Split** mode while drafting to catch rendering issues early, then switch to **Preview** for a final read
* Keep one diagram per fence — multiple Mermaid blocks work, but a single block per diagram keeps source diffs clean
* For long documents, scroll sync is most useful when source and preview have similar structure (headings roughly aligned)
* Upload MD is the fastest way to migrate an existing Markdown doc into Confluence
* Existing macros from earlier versions continue to render unchanged — no migration step required

***

## Related Blog Posts[​](#related-blog-posts "Direct link to Related Blog Posts")

* [Markdown Editor for Confluence — Which App Should You Choose?](/blog/confluence-markdown-editor-comparison.md)
* [Confluence Markdown vs WYSIWYG: Which Should You Use?](/blog/faq-confluence-markdown-vs-wysiwyg.md)

## Support[​](#support "Direct link to Support")

For issues or feature requests, please visit the app's listing on the Atlassian Marketplace.

Was this helpful?👍 Yes👎 No