md2cf

What it is and what it does

md2cf is a command-line tool and Python library that bridges Markdown and Confluence by converting Markdown documents into Confluence Storage Format and uploading them directly to a Confluence instance. It wraps a Mistune-based renderer to handle the Markdown-to-Storage conversion and includes a lightweight REST API client for Confluence Server operations. The tool is designed for automation workflows where you want to publish or mirror Markdown documentation to Confluence without manual page creation.

You provide a Confluence host URL, authentication credentials (username/password or personal access token), a target space, and one or more Markdown files. md2cf handles the conversion, uploads pages, manages attachments, and supports batch operations on folders. It can read from files, directories, or stdin, and offers options to strip headers, add prefaces, manage labels, set parent pages, and detect unchanged content to avoid redundant updates.

Use it for:

• Automate publishing of Markdown-based documentation (e.g., from a Git repo) to a Confluence space on a schedule.
• Mirror technical documentation written in Markdown to Confluence for team access without manual conversion.
• Batch-upload multiple Markdown files or an entire documentation folder to Confluence with consistent formatting.
• Integrate Markdown documentation into CI/CD pipelines to keep Confluence pages in sync with source control.
• Convert and upload Markdown with front-matter metadata (title, labels) to control page properties in Confluence.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Converts Markdown documents to Confluence Storage Format and uploads them to a Confluence instance via REST API, with command-line automation and library support.

Yes, if you need to automate Markdown-to-Confluence publishing and accept dormant maintenance. The tool is stable and has no known vulnerabilities, but expect no active development—use it for straightforward conversion and upload workflows, not as a foundation for custom extensions. For active support or cutting-edge Confluence API features, consider alternatives under active maintenance.

Install

md2cf on PyPI

pip install md2cf

uv add md2cf

poetry add md2cf

Installing md2cf

Before you install

Low install friction with a pure-Python wheel distribution. Maintenance is dormant—last release was 2023-08-06 and last commit 2024-05-21, over a year ago—so expect no active bug fixes or feature updates, though the codebase remains stable for its current scope.

License in practice

MIT license (permissive) allows unrestricted use, modification, and distribution with minimal legal friction.

Quickstart

pip install md2cf

md2cf --host 'https://confluence.example.com/rest/api' --username foo --password bar --space TEST document.md

Requires Python 3.7 or later. Confluence instance URL and valid credentials (username/password or personal access token) are mandatory; token behavior differs between Confluence Cloud and self-hosted instances.

Verify before relying

• Whether the embedded Confluence REST API implementation covers all required operations for your use case beyond basic page creation and updates.
• Current compatibility with recent Confluence Server and Cloud API versions, given dormant maintenance status since mid-2024.

Package facts

Evidence: md2cf-2.3.0-py3-none-any.whl

Keywords: markdown, confluence

Tags

More Markup packages