Skip to main content

confluence-markdown-exporter

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.

Build Python package Build and publish to PyPI PyPI version Docker Hub version Documentation

What it does

Exports individual pages, pages with descendants, folders, 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.5.2/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>

# All pages in a folder (Confluence Cloud)
cme folders <folder-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:

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.

Metadata

Release files for confluence-markdown-exporter 5.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for confluence-markdown-exporter 5.5.2
File Size Uploaded Provenance Actions
confluence_markdown_exporter-5.5.2.tar.gz 431.1 kB Without provenance Details for confluence_markdown_exporter-5.5.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for confluence-markdown-exporter 5.5.2
File Interpreter ABI Platform Actions
confluence_markdown_exporter-5.5.2-py3-none-any.whl Python 3 none any Details for confluence_markdown_exporter-5.5.2-py3-none-any.whl

Total release size: 535.5 kB

Release files / confluence_markdown_exporter-5.5.2.tar.gz

Download URL confluence_markdown_exporter-5.5.2.tar.gz
Size 431.1 kB
Tags Source
SHA-256 checksum
How to use checksums
12dc81b18c9034afe4482e09a7bd9bb8991513490b30d5df302cbaa695b7d07f
BLAKE2b-256 checksum
How to use checksums
eb6e44773ab9cfa53559d8e540b50322d7e09ed29ca4d37ea539b040a4491f89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / confluence_markdown_exporter-5.5.2-py3-none-any.whl

Download URL confluence_markdown_exporter-5.5.2-py3-none-any.whl
Size 104.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e238bf3ec00cbae7f9e4a6f084e7358341242e90d57546bbbb22185041e1aad4
BLAKE2b-256 checksum
How to use checksums
7488552e880165d421f9ead6a56e86d96874ff245cc27079501fd6758c4249db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for confluence-markdown-exporter 5.5.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.5.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page