confluence-markdown-exporter 1.0.1

A tool to export Confluence pages to Markdown

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, Foam, Dendron and more.

Features

• Converts Confluence pages to Markdown format.
• Uses the Atlassian API to export individual pages, pages including children, and whole spaces.
• Supports various Confluence elements such as headings, paragraphs, lists, tables, and more.
• Retains formatting such as bold, italic, and underline.
• Converts Confluence macros to equivalent Markdown syntax where possible.
• Handles images and attachments by linking them appropriately in the Markdown output.
• Supports extended Markdown features like tasks, alerts, and front matter.

Supported Markdown Elements

• Headings: Converts Confluence headings to Markdown headings.
• Paragraphs: Converts Confluence paragraphs to Markdown paragraphs.
• Lists: Supports both ordered and unordered lists.
• Tables: Converts Confluence tables to Markdown tables.
• Formatting: Supports bold, italic, and underline text.
• Links: Converts Confluence links to Markdown links.
• Images: Converts Confluence images to Markdown images with appropriate links.
• Code Blocks: Converts Confluence code blocks to Markdown code blocks.
• Tasks: Converts Confluence tasks to Markdown task lists.
• Alerts: Converts Confluence info panels to Markdown alert blocks.
• Front Matter: Adds front matter to the Markdown files for metadata like page properties and page labels.

Usage

To use the confluence-markdown-exporter, follow these steps:

1. Installation: Install python package via pip.

   pip install confluence-markdown-exporter
   

2. Setting Environment Parameters

   1. Set ATLASSIAN_USERNAME to your Atlassian account email address (e.g. [e-mail])
   2. Set ATLASSIAN_API_TOKEN to your Atlassian token that can be created on https://id.atlassian.com/manage-profile/security/api-tokens
   3. Set ATLASSIAN_URL to your Atlassian instance URL (e.g. https://company.atlassian.net)

   export ATLASSIAN_USERNAME="work mail address"
   export ATLASSIAN_API_TOKEN="API token Test"
   export ATLASSIAN_URL="https://company.atlassian.net"
   

3. Exporting: Run the exporter with the desired Confluence page ID or space key.

   python confluence-markdown-exporter page <page-id e.g. 645208921> <output path e.g. ./output_path/>
   python confluence-markdown-exporter page-with-descendants <page-id e.g. 645208921> <output path e.g. ./output_path/>
   python confluence-markdown-exporter space <space-key e.g. MYSPACE> <output path e.g. ./output_path/>
   

   Instead of confluence-markdown-exporter you can also use the shorthand cf-export.

4. Output: The exported Markdown file(s) will be saved in the specified output directory e.g.:

   output_path/
   └── MYSPACE/
      ├── MYSPACE.md
      └── MYSPACE/
         ├── My Confluence Page.md
         └── My Confluence Page/
               ├── My nested Confluence Page.md
               └── Another one.md
   

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.