Browse documentation
Docs/Markdown Toolkit/Overview and setup

Overview and setup

What the app adds to Confluence, where each part is, and what conversion actually means.

What it is. Three things. A way to get Confluence content out as Markdown files; a way to bring a Markdown archive back in as a tree of pages; and a macro that renders Markdown — diagrams, maths and highlighted code included — inside a Confluence page.

Why you would want it. Documentation that also needs to live in a repository. Content you want to feed to a static site generator or an AI pipeline. A folder of Markdown that should become real Confluence pages without anyone pasting them one at a time. Diagrams that must be editable as text by anyone who can edit the page, rather than uploaded as images nobody can correct.

Who can use it. Anyone who can open the space. The Markdown Toolkit page sits in the space sidebar, not in space settings, and every read runs with your own Confluence permissions — a space export lists only the pages you can already open. Importing additionally needs permission to create pages in the target space, which Confluence checks for you. There is no global admin screen and nothing to configure.

It cannot exceed your own permissions
Every read runs as you, so an export can only contain pages you can already open. An import writes only underneath a page you created, in your name — if you cannot create pages in that space, the import stops there and nothing else is written. See Permissions, data and limits.

What the macro does to a page

This is the whole of it. You type a fenced mermaid block into the macro, and the page draws it. The diagram below is rendered by the same library the macro runs — open Show source to see the eight lines behind it.

```mermaid · flowchartExample
An escalation path lifted from a real runbook. Eight lines of text on the page, and no image to keep up to date.

Twenty-one diagram types render this way, alongside KaTeX maths and syntax-highlighted code, so an architecture note or a runbook keeps its pictures in the page rather than in a folder of screenshots. The gallery renders one example of every type.

The three places you will find it

FeatureWhereWhat it does
Markdown Toolkit pageThe space sidebar, with Pages and BlogsExport and Import, in two tabs: pick pages from the tree, take the whole space, or drop an archive back in.
Export to MarkdownThe ••• menu on any pageExports that page, optionally with its children, without leaving the page.
Markdown macroType /Markdown on any pageWrite Markdown, get rendered output on the page.

Install it

  1. 1Install Markdown Toolkit for Confluence from the Atlassian Marketplace.
  2. 2Open a space and look for Markdown Toolkit in the sidebar.
  3. 3That is all. There is no setup screen, no credentials and no global settings.

What “conversion” means, and its one limitation

Confluence stores pages in its own XHTML dialect, not Markdown. Exporting converts that format to Markdown: text, headings, lists, tables, links, images and code blocks all come across cleanly.

Some Confluence macros cannot become Markdown
A live filter, a Jira issues macro or a complex layout has no Markdown equivalent. Instead of dropping them silently, the converter leaves a comment at that position naming the macro. So an exported page tells you where something dynamic was, rather than looking complete when it is not.

Something missing or wrong on this page? Tell us in the support portal or email contact@synapseoasis.com.