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.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96d4810a70ef3b1c3bb603f7672f4e9c0817d9efb358c6d17c330ceacd7b4b0e |
|
MD5 | a90b453c05cc6f4b0f918451c2d6176a |
|
BLAKE2b-256 | 77846534c93e58ea4a8f08fcb6b58eefd3ff061020576444f42bd1fa280fc8f1 |
Close
Hashes for mkdocs_confluence-0.2.3.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aec51790d0728a35b443750fbd54dfa04074983124ff1b09ef71c5f26b91962a |
|
MD5 | 69bc43afdfabed303d06e5f648522360 |
|
BLAKE2b-256 | 880fd4a69eb22aff649af81708a95e666ddec10da86f3eae24f919d1eb0e71a2 |