Searchable Markdown for Confluence

Documentation

Install

A site administrator installs it into your Confluence Cloud site from the app's listing on the Atlassian Marketplace.

Insert the macro

1. Edit a Confluence page.
2. Type /markdown and choose Markdown.
3. The configuration panel opens on the right. Paste or write your Markdown there, and the macro shows it rendered on the page.
4. Publish the page.

What is supported

Headings, bold, italic, strikethrough, inline code, links, bullet and numbered lists (including nested lists and the starting number), task lists with checkboxes, tables with headers, block quotes, fenced code blocks, horizontal rules, hard line breaks, HTML entities and backslash escapes.

Search

The text you write in the macro is added to the Confluence search index, so a word that appears only inside the macro can be found from the search box. Indexing happens when the page is published or updated, and may take a few minutes to appear in results.

Export

When a page containing the macro is exported to PDF, the macro's content is exported with it.

Dark mode

The content is rendered by Confluence's own renderer, so it follows the theme of whoever is reading, including dark mode.

Known limitations

• Images with an external URL are shown as a link, not as an image. Atlassian's document format only allows media hosted by Atlassian inside a macro. To display an image, upload it to the page and insert it with Confluence's own image tool.
• Raw HTML is not executed. HTML blocks are displayed as code, so nothing is injected into your page.
• Links are limited to http, https, mailto and page-relative addresses. Anything else is shown as plain text, on purpose.
• Search results show the Markdown as written, including its symbols (for example # before a heading), because Confluence indexes the text exactly as it is stored.

Licensing

Billing is handled by Atlassian through the Marketplace. Your Markdown is saved inside the page itself, so it stays in your site whatever happens to the license.

Support

Write to support@nordikaapps.com. Include your Confluence site URL and, if you can, the Markdown that produced the problem. We answer in writing.