MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API

Go to file

Pawel Sikora fd5bf17a7a fix source and include files for coveragecv		2021-05-30 20:30:21 +02:00
mkdocs_with_confluence	more prints to verbose mode, add more exception handling	2021-05-05 06:56:58 +02:00
tests	fix obtaining parents ids	2021-05-05 06:28:07 +02:00
.coveragerc	fix source and include files for coveragecv	2021-05-30 20:30:21 +02:00
.pre-commit-config.yaml	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
.travis.yml	add nosetests	2021-04-29 22:59:04 +02:00
codecov.yml	update codecov.yml	2021-04-28 22:54:10 +02:00
LICENSE	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
README.md	make an order!	2021-04-28 23:07:17 +02:00
requirements_dev.txt	add nosetests	2021-04-29 22:59:04 +02:00
requirements.txt	fix mimetypes pip package in requirements	2021-04-28 22:46:37 +02:00
setup.py	more prints to verbose mode, add more exception handling	2021-05-05 06:56:58 +02:00

README.md

mkdocs-with-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-with-confluence

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - mkdocs-with-confluence

More information about plugins in the [MkDocs documentation][mkdocs-plugins].

Usage

Use following config and adjust it according to your needs:

  - mkdocs-with-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