Skip to content

Confluence Markdown Exporter

Confluence Markdown Exporter

Export Confluence pages to Markdown for Obsidian, Gollum, Azure DevOps, Foam, Dendron and more.

Get started View on GitHub

What it does

  • One-command install

    A single curl/PowerShell line installs an isolated, self-updating CLI via uv. No virtualenv juggling.

    Installation

  • Pages, spaces, orgs

    Export a single page, a page subtree, an entire space, or every space in your Atlassian organisation.

    Usage

  • Incremental by default

    Skips unchanged pages using a lockfile. Re-runs export only what actually moved since last time.

    Features

  • Target presets

    Pre-baked configurations for Obsidian (wiki links, Dataview, Meta Bind) and Azure DevOps wikis (sanitized filenames, attachments folder).

    Target systems

  • Macros and add-ons

    Status badges, panels, page properties, draw.io, PlantUML, Mermaid, include/excerpt: all converted to portable Markdown.

    Features

  • Cloud and Server

    Works against Confluence Cloud, the Atlassian API gateway, and on-premise Server / Data Center. API tokens, PATs and scoped tokens are all supported.

    Authentication

Get going in 60 seconds

Install, authenticate, export. That is the whole flow.

1. Install

# Installs an isolated, self-updating CLI via uv.
curl -LsSf uvx.sh/confluence-markdown-exporter/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/confluence-markdown-exporter/install.ps1 | iex"

# Install as an isolated tool...
uv tool install confluence-markdown-exporter

# ...or run it once without installing:
uvx confluence-markdown-exporter --help

pip install confluence-markdown-exporter

# Prebuilt image, for non-interactive / CI use.
docker pull spenhouet/confluence-markdown-exporter:latest
docker run --rm spenhouet/confluence-markdown-exporter --help

2. Authenticate

cme config edit auth.confluence

Inside a container there is no interactive menu: generate the config on a workstation, then mount it (or pass CME_AUTH__* env vars). See the Docker page.

3. Export

# A page, a subtree, an entire space, or every space of an org:
cme pages   https://example.atlassian.net/wiki/spaces/SPACE/pages/123/Title
cme spaces  https://example.atlassian.net/wiki/spaces/SPACE
cme orgs    https://example.atlassian.net

Detailed setup and per-target presets live in the installation docs.