MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API
Project description
mkdocs-confluence
MkDocs plugin that converts markdown pages into confluence markup and export it to the Confluence page
Setup
Install the plugin using pip:
pip install mkdocs-confluence
Activate the plugin in mkdocs.yml
:
plugins:
- search
- mkdocs-confluence
More information about plugins in the MkDocs documentation: mkdocs-plugins.
Usage
Use following config and adjust it according to your needs:
- mkdocs-confluence:
host_url: https://<YOUR_CONFLUENCE_DOMAIN>/rest/api/content
space: <YOUR_SPACE>
parent_page_name: <YOUR_ROOT_PARENT_PAGE>
username: <YOUR_USERNAME_TO_CONFLUENCE>
password: <YOUR_PASSWORD_TO_CONFLUENCE>
enabled_if_env: MKDOCS_TO_CONFLUENCE
#verbose: true
#debug: true
dryrun: true
Parameters:
Requirements
- md2cf
- mimetypes
- mistune
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
Built Distribution
Close
Hashes for mkdocs-confluence-0.2.3.dev2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 995e006cd55ae1fbf3847857f66bdbfde68f48ccaea63e571c8da28dbb07a7be |
|
MD5 | 5c63ac3f305dd32d2513fa0729a6cfdb |
|
BLAKE2b-256 | 316eda8c6cc51ba3257561d7e149c7e06c042be966bdf54e95b827d193418835 |
Close
Hashes for mkdocs_confluence-0.2.3.dev2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d242e43b8a0fe610b0fbaf7a78cb2084b690fd61e71d327629d89851ac9d6a09 |
|
MD5 | 409e2d7b6e1430722c388a3bbb799c60 |
|
BLAKE2b-256 | 989bf00382dfaab4c6af7e75cdedc74cf4cdad7cb65db0b0032b813a4cf69140 |