Sharing a document

Two options let you share a markdown document. Copy URL gives you a link straight to the document's view page. Copy as macro gives you a reference URL (.../assets/markdown/templates/<id>). Paste it into a Confluence page and it turns into a Markdown reference macro automatically.

Reference URLs are only offered for documents saved in Capable. You won't see one for the bundled examples, or for markdown that comes from a URL or a page attachment.


#Where you do it

Task

Where

Add a markdown document to a page

In the Confluence editor, type /Markdown (Capable) if you have the Capable Suite, or /Markdown macro (Capable) if you use the standalone app. You can also use the Markdown byline entry on a published page.

Write or edit the document body

The macro's Configure action, the maximize button on the rendered macro, or Edit on the library page

Upload or paste an image into the document

Editor toolbar → + → Image 'From upload', paste from the clipboard, or drop the file on the editor


#Worth knowing

  • The document macro's Title isn't saved from the macro settings. It's saved onto the stored document, and the header shows that document's title.

  • Documents that come from a URL show nothing to logged-out readers. Documents stored as an attachment or on the page do show for them.

  • The duplicate-title check only looks at documents stored directly in the space's Capable storage. If the check itself fails, the save goes ahead anyway.

  • A macro whose stored document belongs to a different page won't save. You'll hit this on a copied page until it's reconciled.


#Limits that apply here

  • Large documents: past 500,000 characters, the document shows inside a fixed-height scroll box with a warning banner.

  • Document size: creating or updating a markdown document through the Capable tools is refused above 512 KB.



How it actually behaves.