GitHub-Flavored Markdown rendering
Markdown in Capable renders the way it does on GitHub. That covers tables, task lists, strikethrough, automatic links, footnotes, GitHub-style alert blockquotes, links on headings, and syntax highlighting in code blocks. Capable also strips out raw HTML as a safety measure.
#Where you do it
Task | Where |
|---|---|
Add a markdown document to a page | In the Confluence editor, type /Markdown (Capable) [Suite] or /Markdown macro (Capable) [standalone]. On a published page, you can also use the Markdown entry in the byline. |
Show a border and a title on the macro | Configure Markdown → 'Show border' checkbox and the 'Markdown title' field |
Point a macro at a README on GitHub, GitLab or Bitbucket | Configure Markdown → Markdown from URL |
#Settings that affect this
Setting | Where | What it does |
|---|---|---|
Global settings → Capabilities → Markdown | - | Hiding Markdown removes it from the Capable navigation bar and the byline menu across the whole site. It does not stop existing macros from rendering. |
Space settings → Space Capability Settings | - | Auto shows the byline entry only when the page already contains markdown. Always shows it in every page's byline in that space. Never hides it there. |
Global settings → Features → AI integration | - | 'Allow AI-powered features across Capable. Turn off to disable AI for all users.' Turning it off removes the Studio (Generate markdown with AI) section from the markdown library. |
#Worth knowing
The macro's 'Markdown description' field doesn't save what you type, although Capable still warns you about unsaved changes if you edit it.
If you use a self-hosted diagram renderer, it isn't currently used for diagrams written as fenced code blocks in markdown.
'Copy as macro' isn't available for the built-in Examples, or for markdown loaded from a URL or an attachment.
Markdown documents never get a thumbnail or preview image anywhere. That is by design.
On a published Capable Site, markdown is rendered again by a different renderer, so the site page can look different from the Confluence page. Diagrams written as fenced code blocks show as plain code blocks.
#Related
How it actually behaves.
