Markdown to Confluence - upload any .md files to your Confluence cloud page
Project description
confluence.md
Push markdown files straight to a Confluence page.
What it does?
confluence.md
allows you to push any markdown file to Confluence. You can create
a new page (under given parent) or update an existing one.
How to install?
It's as easy as:
$ pip install confluence.md
How to use it?
Markdown to Confluence
Example workflow:
1. Create a new page under --parent_id
:
$ confluence.md --user user@name.net --token 9a8dsadsh --url https://your-domain.atlassian.net \
create --file README.md --parent_id 182371 --title "new title" --add_meta
2. The page is created and the file is decorated with metadata:
$ head -n 3 markdown.md
---
confluence-url: https://your-domain.atlassian.net/wiki/spaces/SP/pages/18237182/new+title
---
3. Performing an update does not require providing --page_id
and --url
:
$ confluence.md --user user@name.net --token 9a8dsadsh update --file README.md
Doing an update with --page_id
and --url
is still possible.
Consider adding useful --add_info
option.
To create Atlassian API Token go to api-tokens.
Actions:
update
Updates page content based on givenpage_id
or metadata in Markdown filecreate
Creates new page under givenparent_id
positional arguments:
{update,create}
Action to run
optional arguments:
-h
,--help
show this help message and exit--file FILE
input markdown file to process--add_meta
adds metadata to .md file for easy editing--add_info
adds info panel automatic content do not edit on top of the page--add_label
ADD_LABEL
adds label to page-v
,--verbose
verbose mode-q
,--quiet
quiet mode
required auth parameters:
-u
USER
,--user
USER
Atlassian username/email-t
TOKEN
,--token
TOKEN
Atlassian API token-l
URL
,--url
URL
Atlassian instance URL
create page parameters:
--parent_id
PARENT_ID
define parent page id while creating a new page--title
TITLE
define page title while creating a new page--overwrite
force overwrite if page with this title already exists
update page arguments:
--page_id
PAGE_ID
define (or override) page id while updating a page
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
confluence.md-0.3.1.tar.gz
(8.1 kB
view hashes)
Built Distribution
Close
Hashes for confluence.md-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28331dae6716a2119f22a0a9edef38cf9aeaf5c1cc9b5c3965942e703a84677e |
|
MD5 | 958c51ce762ab9f8484790a305760843 |
|
BLAKE2b-256 | 2ffdcaa7ac07bff237b5eec562a0b8fe48315895d2c58c812acd82afae26abb8 |