Markdown to Confluence import
A script to import a named markdown document into Confluence.
It handles inline images as well as code blocks.
Also there is support for some custom markdown tags for use with commonly used Confluence macros.
The file will be converted into HTML or Confluence storage markup when required.
Then a page will be created in the space or if it already exists, the page will be uploaded.
The project code and dependencies can be used based on python virtualenv.
Create a new python virtualenv:
> python3 -m venv venv
Or in Anaconda
conda create --name md_to_conf python=3.7 --yes
Make the virtualenv active:
> source venv/bin/activate
Required python dependencies can be installed using:
pip3 install -r requirements.txt
To use it, you will need your Confluence username, API key and organisation name. To generate an API key go to https://id.atlassian.com/manage/api-tokens.
You will also need the organization name that is used in the subdomain. For example the URL:
https://fawltytowers.atlassian.net/wiki/would indicate an organization name of fawltytowers.
If the organization name contains a dot, it will be considered as a Fully Qualified Domain Name. For example the URL:
https://fawltytowers.mydomain.com/would indicate an organization name of fawltytowers.mydomain.com.
These can be specified at runtime or set as Confluence environment variables (e.g. add to your
~/.bash_profileon Mac OS):
export CONFLUENCE_USERNAME='basil' export CONFLUENCE_API_KEY='abc123' export CONFLUENCE_ORGNAME='fawltytowers'
On Windows, this can be set via system properties.
The minimum accepted parameters are the markdown file to upload as well as the Confluence space key you wish to upload to. For the following examples assume 'Test Space' with key:
python3 md2conf.py readme.md TST
Mandatory Confluence parameters can also be set here if not already set as environment variables:
python3 md2conf.py readme.md TST -u basil -p abc123 -o fawltytowers
Use -h to view a list of all available options.
Use -a or --ancestor to designate the name of a page which the page should be created under.
python md2conf.py readme.md TST -a "Parent Page Name"
Use -d or --delete to delete the page instead of create it. Obviously this won't work if it doesn't already exist.
Use -l or --loglevel to specify a different logging level, i.e DEBUG.
Use -s or --simulate to stop processing before interacting with confluence API, i.e. only converting the markdown document to confluence format.
The original markdown to HTML conversion is performed by the Python markdown library. Additionally, the page name is taken from the first line of the markdown file, usually assumed to be the title. In the case of this document, the page would be called: Markdown to Confluence Converter.
Standard markdown syntax for images and code blocks will be automatically converted. The images are uploaded as attachments and the references updated in the HTML. The code blocks will be converted to the Confluence Code Block macro and also supports syntax highlighting.
If present, what is between the doctoc anchor format:
will be replaced by confluence "toc" macro leading to something like:
Table of Content
true disc 7 1 list clear .*
Warning: Any blockquotes used will implement an information macro. This could potentially harm your formatting.
Block quotes in Markdown are rendered as information macros.
> This is an info
> Note: This is a note
> Warning: This is a warning
Alternatively, using a custom Markdown syntax also works:
~?This is an info.?~
!This is a note.! %This is a warning.%
╚⊙ ⊙╝ ╚═(███)═╝ ╚═(███)═╝ ╚═(███)═╝ ╚═(███)═╝ ╚═(███)═╝ ╚═(███)═╝