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.dev3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 801ef93eaf250538a28517fa1724baf5d251c678b56d376f6009675105d27484 |
|
MD5 | c500b89b18ac22fc74f84a89c39d51a8 |
|
BLAKE2b-256 | 633df2bde7bf37bba79e8401823d39bc45abed86c05c0c5c4c69acd9d887abed |
Close
Hashes for mkdocs_confluence-0.2.3.dev3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8471c8ceb9cded5ab6f8fb0a43e96446880cfeeec40984af26529e481b24ef2a |
|
MD5 | 19b4533001b7e1e493d65e43df20b577 |
|
BLAKE2b-256 | 4f5e0e4c9555668d3378cf4b34dd11f8e7d8e2b086f587a27640f2fbbb6bf309 |