ccfm.io

What It Is

CCFM (Confluence Cloud Flavoured Markdown) is a CLI tool for Confluence Cloud that converts Markdown into Atlassian Document Format (ADF) and deploys it as native Confluence pages. It is not positioned as a simple HTML or legacy storage-format converter; instead, it generates native pages that can be opened and edited normally in the Confluence editor. This makes it a good fit for bringing technical documentation into Git and CI/CD workflows.

Core Capabilities

In terms of functionality, CCFM can automatically map a directory structure to a Confluence page hierarchy. Markdown files create corresponding pages, while directories can generate container pages; the content of those container pages can also be controlled via .page_content.md. In addition to standard Markdown, CCFM provides extensions such as status badges, panels, expandable sections, dates, smart page links, emoji, image width control, and more. Its deployment model is similar to Terraform: it supports plan previews, apply execution, idempotent create/update operations, remote state, orphan page detection, and a locking mechanism to avoid conflicts from concurrent deployments.

Integrations, API, and Documentation

The tool accesses Confluence Cloud via an Atlassian API Token. It can be installed with pip install ccfm-convert and also provides a Docker image, making it suitable for GitHub Actions or other CI/CD pipelines. The documentation recommends storing docs in a version control system such as Git to enable review, auditing, rollback, and collaboration. The documentation is fairly complete, covering quick start, syntax reference, CLI reference, configuration, deployment models, Docker & CI/CD, architecture, troubleshooting, and FAQ. It also clearly explains the design rationale behind the “one space, one configuration” approach.

Pricing and Limitations

The main text does not mention commercial pricing, payment methods, or SLA, nor does it clearly specify a license. The main limitation is that each Confluence space must be managed by a single unique ccfm.yaml; deploying from multiple repositories to the same space can cause state conflicts, and orphan detection may plan to delete pages created by other repositories. In addition, when a container page is deployed for the first time, links referencing child pages may not resolve immediately, requiring a second forced deployment or the use of Confluence’s Children Display macro instead.

Who It’s For and Access from China

CCFM is suited to development teams, platform teams, and technical writing teams that use Docs-as-Code and want to automatically publish from a single documentation repository to Confluence Cloud. It is less suitable for organizations that need multiple repositories to write to the same Confluence space, rely heavily on graphical interfaces, or require clearly defined commercial support. The main text does not provide information about access from China; actual usability will depend on network access to Atlassian Cloud, GitHub/GHCR, pip package sources, and related services. If needed, alternatives include native Confluence editing, other Markdown publishing tools, or a self-hosted MkDocs/Docusaurus documentation site.