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.4.0/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
cmeCLI. Inside the Docker image there is no interactivecme configmenu; you supply a pre-defined config (mounted JSON file orCME_*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.
1 maintainer
Metadata
1 maintainer
Release files for confluence-markdown-exporter 5.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| confluence_markdown_exporter-5.4.0.tar.gz | 386.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| confluence_markdown_exporter-5.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 473.0 kB
Release files / confluence_markdown_exporter-5.4.0.tar.gz
| Download URL | confluence_markdown_exporter-5.4.0.tar.gz |
|---|---|
| Size | 386.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98a9b5d58a7ba99ac271c1765165eba629c559a8a9e3d4b5188fbc673119b684
|
|
BLAKE2b-256 checksum How to use checksums |
21dd014f9b0f70d68391f4443a91ec1998c5a6ce75715a0dc73f9717431f7825
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","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.4.0-py3-none-any.whl
| Download URL | confluence_markdown_exporter-5.4.0-py3-none-any.whl |
|---|---|
| Size | 87.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
298b05035a8e9741d419462c4562377ddeb1a65a516a1751f2522fd4c84a6154
|
|
BLAKE2b-256 checksum How to use checksums |
b25c004b88cb0a4d753425d97c5a8ec6d84eeb563006a1114de33673d74c2977
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","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}
|
