Searchable Markdown for Confluence
Documentation
New to Markdown in Confluence? See what Confluence does on its own, and when a macro helps.
Install
A site administrator installs it into your Confluence Cloud site from the app's listing on the Atlassian Marketplace.
Insert the macro
- Edit a Confluence page.
- Type
/markdownand choose Searchable Markdown for a block, or Searchable Markdown (inline) to keep it inside a sentence. - The configuration panel opens on the right by itself. Paste or write your Markdown there, and the macro shows it rendered on the page.
- 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 with syntax highlighting, horizontal rules, hard line breaks, HTML entities and backslash escapes. As in CommonMark and GitHub, a single line break inside a paragraph is shown as a space; end a line with two spaces or a backslash to force a break.
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. Documents of up to about 4,000 words are searchable end to end; for longer documents, Confluence's search covers the beginning of the text.
Export
When a page containing the macro is exported to PDF or Word, 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,mailtoand 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. - Search covers about the first 4,000 words of each macro. Longer documents are still displayed and exported in full, but words beyond that point cannot be found from the search box.
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. If a site's license is not active, the macro stops formatting and shows your Markdown as plain text: nothing is hidden and nothing is lost.
Support
Write to support@nordikaapps.com. Include your Confluence site URL and, if you can, the Markdown that produced the problem. Support is by email only, and we answer in writing.
Response times. Requests that Atlassian identifies as critical: within 24 hours. Every other request: within five business days.