Skip to content

Features

Exports individual pages, pages with descendants, folders, or entire spaces via the Atlassian API. Skips unchanged pages by default, re-exporting only what has changed since the last run.

Supported Confluence features

Content & formatting

  • Rich text: headings, paragraphs, bold, italic, underline, lists, tables, links, images, attachments, and image captions
  • Page links: links to Confluence pages become relative Markdown links, whether they were inserted as page links, pasted as full page URLs, or pasted as tiny links (/wiki/x/..., the "Copy link" shortlink)
  • Images: saved as local attachment files and linked, or embedded as base64 data URIs with export.embed_images
  • Emoticons: Cloud emoji and Server/Data Center emoticons converted to Unicode characters
  • File previews: the View File / PDF preview macro (viewpdf) becomes a link to the attachment
  • Code blocks: language-aware fenced code blocks
  • Task lists: checkboxes with completion state
  • Text highlights & font colours: preserved with inline HTML colour styling
  • Status badges: converted to coloured inline highlights
  • Info / note / tip / warning panels: converted to Markdown alert blocks ([!NOTE], [!TIP], …)
  • Comments: open inline and/or page-level (footer) comments exported as sidecar files next to each page
  • Include / excerpt-include macros: embedded pages either inlined or exported as Obsidian transclusion links (![[Page Title]])

Page metadata

  • Page properties: Page Properties macro exported as YAML front matter, Dataview inline fields, or Meta Bind VIEW fields; duplicate keys are disambiguated automatically (configurable via export.page_properties_format)
  • Page Properties Report: dynamic cross-page property tables exported as a static snapshot or a live Dataview DQL query (configurable via export.page_properties_report_format). Reports nested inside a third-party app macro (for example Table Filter) are also exported. Note that such apps apply their filtering, sorting and column hiding in the browser, and that behaviour is not available through the API, so the export contains the full unfiltered report.
  • Page labels: exported as tags in YAML front matter

Diagrams & add-ons

  • draw.io: diagram files saved as attachments and shown via their preview image, on Cloud and on Server/Data Center; embedded Mermaid diagrams extracted as fenced Mermaid blocks
  • Gliffy: diagrams shown via their preview image; the diagram source is saved with a .gliffy extension
  • PlantUML: exported as fenced PlantUML code blocks, both the Server/Data Center macro (plantuml) and the Cloud macro (plantumlcloud); the diagram source is exported, not the rendered image
  • Markdown Extensions: pass-through of raw Markdown macro content

Output layout

  • Path templates: page and attachment paths are built from templates (export.page_path, export.attachment_path)
  • Directory index pages: parent pages can be exported as index.md or README.md inside a directory named after the page (export.page_path_if_parent)
  • Stale file cleanup: files of pages that were deleted, renamed or moved in Confluence are removed on the next run