kheast / confluence-pusher

A tool to convert and upload markdown documents into Atlassian Confluence

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

confluence-pusher

A tool to convert and upload markdown documents into Atlassian Confluence using the Atlassian Python API.


How it works

File conversion

Warning: Confluence can't create two documents with the same name in the same space, for example: folder /Build and file named build.md

The source folder is traversed for markdown files. The folder and document structures are replicated in Confluence. The document conversion is performed using Pandoc with the pandoc-confluence-writer custom filter:

Local Confluence
Root Folder Root Document
README.md Root Document Content
others.md Sub-Page under Root Document
Sub-Directory Section Document

The document names are renamed to reflect the H1 markdown header if available.


Before you begin

Configure Confluence API

About

A tool to convert and upload markdown documents into Atlassian Confluence

License:MIT License


Languages

Language:Lua 61.9%Language:Python 38.1%