confluence-markdown-exporter 5.1.1

A tool to export Confluence pages to Markdown

The confluence-markdown-exporter exports Confluence pages in Markdown format. This exporter helps in migrating content from Confluence to platforms that support Markdown e.g. Obsidian, Gollum, Azure DevOps (ADO), Foam, Dendron and more.

What it does

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

Supported targets include Obsidian, Gollum, Azure DevOps (ADO) wikis, Foam, Dendron, and anything else that consumes Markdown.

Full feature list, configuration reference, and target-system presets live in the documentation site.

Quickstart

1. Install

macOS and Linux

curl -LsSf uvx.sh/confluence-markdown-exporter/install.sh | sh

Windows

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

Installing a specific version:

curl -LsSf uvx.sh/confluence-markdown-exporter/5.1.1/install.sh | sh

Alternative install methods (PyPI via pip / uv, prebuilt Docker image) are covered in the installation docs and the Docker page.

Using the Docker image? Steps 2 and 3 below use the local cme CLI. Inside the Docker image there is no interactive cme config menu; you supply a pre-defined config (mounted JSON file or CME_* environment variables) and run a single export command per container invocation. See the Docker page for the non-interactive flow.

2. Authenticate

Set Confluence credentials interactively (URL, username, API token / PAT):

cme config edit auth.confluence

See Authentication for token scopes and Jira setup.

3. Export

# A single page
cme pages <page-url>

# A page and all its descendants
cme pages-with-descendants <page-url>

# An entire space
cme spaces <space-url>

# Every space of an organisation
cme orgs <base-url>

Output goes to the configured export.output_path (current directory by default).

Documentation

The full documentation lives at https://spenhouet.github.io/confluence-markdown-exporter/ and includes:

• Installation (curl / PowerShell / pip / uv)
• Usage guide: pages, descendants, spaces, orgs, output layout
• Feature list: supported Confluence content, macros, and add-ons
• Configuration: config commands, ENV vars, full option reference
• Target-system presets: Obsidian, Azure DevOps, …
• Docker: prebuilt images for non-interactive / CI use
• CI / non-interactive use
• Compatibility and Troubleshooting

Contributing

If you would like to contribute, please read our contribution guideline.

License

This tool is an open source project released under the MIT License.