Write Markdown in Confluence

To write Markdown in Confluence, type /markdown in the editor and choose Markdown (Capable). In Configure Markdown, pick Markdown from scratch, give the document a title and write it in the editor, then click Save. The page shows the rendered result, formatted the way GitHub would show it.


#Before you start

  • You need permission to edit the page.

  • Capable Markdown, or the Capable suite, must be installed on your Confluence site.

  • In the standalone app the macro is called Markdown macro (Capable).


#Steps

  1. Open the page in the editor, type /markdown and choose Markdown (Capable). The full-screen Configure Markdown picker opens.

  2. Choose Markdown from scratch.

  3. Type a title in Markdown title if you want one.

  4. Write your Markdown. Use the toolbar for formatting and the + menu to add images and diagrams.

  5. Switch to split or preview mode to check how it will look.

  6. Tick Show border if you want a border and the title strip on the page.

  7. Click Save, then publish the page.


#What happens next

The document is stored with the page and renders as GitHub-Flavored Markdown: tables, task lists, footnotes, alerts and syntax-highlighted code. Code blocks in a supported diagram language become pictures. To change it later, edit the page and open the macro again, or hover the rendered macro and use the maximise button.



Write it the way you already write README files.