Frequently asked questions about Markdown in Confluence

Short answers to the questions we hear most, each with a link to the page that explains it properly.


#Writing and importing

#Can I write Markdown directly in Confluence?

Yes. Insert the Markdown macro, choose Markdown from scratch and write in the edit, split and preview editor. See Write Markdown in Confluence.

#Can I import a .md file?

Yes. Use Upload file in the editor for an editable copy, or Markdown from file to render an attachment. See Import a Markdown file into Confluence.

#Can I show a README from a private repository?

No. Capable fetches the file without your sign-in, so it must be publicly reachable. See Show a GitHub README in Confluence.

#Which diagram languages can I use?

27, including Mermaid, PlantUML and BPMN, written as fenced code blocks. See Diagrams from fenced code blocks.

#Why can I not upload an image while editing a library template?

Uploaded images become attachments of the page that shows the document, and a library template has no page. Upload images while editing a document on a real page, or pick them from the library. See Cannot upload an image while editing a library template.


#Templates

#If I edit a template, do pages that use it update?

Pages that use the Markdown reference macro do. Pages where the template was inserted as an ordinary Markdown document keep their own copy. See Markdown reference.

#Can I find templates from the page byline?

In the Capable suite, yes. The search in the Capable byline item finds your space and global templates and the built-in starter templates, and opens the editor ready to insert. See Insert a Markdown template from the byline.

#Why does a starter template have no version history?

The 17 starter templates ship with the app and never change, so there is no history to show. Remix one into your space if you want your own versions. See Version history.


#Readers, exports and admin

#Why does a logged-out reader see Sign in to view this markdown?

The document is loaded for each reader, and Confluence does not let the app do that for someone it cannot identify. Publish the page with Capable Sites for anonymous audiences. See the troubleshooting page.

#Why does an exported Word or PDF show raw Markdown?

Confluence's export includes the Markdown document as a code block of its source. For a rendered copy, publish it to a Capable Site. See Exported Word or PDF shows raw markdown source.

#Can I hide Markdown from my site or a space?

Yes. An administrator can hide it in Capable's global settings, and a space administrator can hide it in space settings. Macros already on pages keep rendering. See Markdown settings.



Not here? The troubleshooting pages go deeper.