MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API
edcb998af4
Add handling of missing (may be on purpose)
navigation section (nav) in mkdocs.yml config file.
If pages are missing in nav, plugin will create the
required pages from the filesystem structure, e.g.
parent1/parent2/.../your_page.md:
# My Page
...
In the following manner:
Confluence Space:
* Main Parent:
* Parent1:
* Parent2:
...:
- My Page
Fix for Issue: #2
|
||
|---|---|---|
| mkdocs_with_confluence | ||
| tests | ||
| .coveragerc | ||
| .pre-commit-config.yaml | ||
| .travis.yml | ||
| codecov.yml | ||
| LICENSE | ||
| README.md | ||
| requirements_dev.txt | ||
| requirements.txt | ||
| setup.py | ||
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