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

Go to file

Pawel Sikora 88db9014a7 Fix Action status badge		2021-04-28 21:48:52 +02:00
mkdocs_with_confluence	Add initial v0.1.0 plugin code	2021-04-14 22:58:26 +02:00
.codecov.yaml	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
.pre-commit-config.yaml	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
.travis.yml	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
LICENSE	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
README.md	Fix Action status badge	2021-04-28 21:48:52 +02:00
requirements.txt	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00
setup.py	Update README, LICENSE, and yaml workflow files	2021-04-23 20:04:21 +02:00

README.md

](https://github.com/pawelsikora/mkdocs-with-confluence/actions) ![PyPI - License](https://img.shields.io/pypi/l/mkdocs-with-confluence

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