MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API
Go to file
2024-09-11 14:11:06 +00:00
.github/workflows Refactoring (#1) 2023-02-24 08:40:21 +00:00
example Update variable naming (#7) 2023-02-28 10:42:32 +00:00
mkdocs_with_confluence fix: do not add ancestors if page is in the root 2023-02-28 16:34:54 +01:00
.dockerignore Refactoring (#1) 2023-02-24 08:40:21 +00:00
.gitignore Refactoring (#1) 2023-02-24 08:40:21 +00:00
.sops.yaml Refactoring (#1) 2023-02-24 08:40:21 +00:00
LICENSE Update README, LICENSE, and yaml workflow files 2021-04-23 20:04:21 +02:00
Makefile Update variable naming (#7) 2023-02-28 10:42:32 +00:00
poetry.lock Refactoring (#1) 2023-02-24 08:40:21 +00:00
pyproject.toml upgrade version 2023-02-28 16:35:30 +01:00
README.md fix: typo in Readme.md 2023-02-24 17:41:10 +01:00
renovate.json Add renovate.json 2024-09-11 14:11:06 +00:00

mkdocs-with-confluence

MkDocs plugin that converts markdown pages into confluence markup and export it to the Confluence page

How to use

To enable plugin, you need to set the MKDOCS_TO_CONFLUENCE environment variable.

export MKDOCS_TO_CONFLUENCE=1

By default the dry-run mode is turned off. If you wan't to enable it, you can use the config file, ot the MKDOCS_TO_CONFLUENCE_DRY_RUN environment variable

export MKDOCS_TO_CONFLUENCE_DRY_RUN=1

Setup

Install the plugin using pip:

pip install https://github.com/allanger/mkdocs-with-confluence/releases/download/v0.3.1/mkdocs_with_confluence-0.3.1.tar.gz

Activate the plugin in mkdocs.yml:

plugins:
  - 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> # JIRA_USERNAME env var can be used
        password: <YOUR_PASSWORD_TO_CONFLUENCE> # JIRA_PASSWORD env var can be used
        dryrun: true # MKDOCS_TO_CONFLUENCE_DRY_RUN env var can be used
        header_message: <A_MESSAGE_THAT_WILL_BE_ADDED_TO_EVERY_PAGE>
        upstream_url: <URL_OF_YOUR_MKDOCS_INSTANCE>
        header_warning: "‼️ This page is created automatically, all you changes will be overwritten during the next MKDocs deployment. Do not edit a page here ‼️"

Requirements

  • md2cf
  • mimetypes
  • mistune