Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pawelsikora/mkdocs-with-confluence
MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API
https://github.com/pawelsikora/mkdocs-with-confluence
Last synced: 5 days ago
JSON representation
MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API
- Host: GitHub
- URL: https://github.com/pawelsikora/mkdocs-with-confluence
- Owner: pawelsikora
- License: mit
- Created: 2021-04-14T20:48:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T12:58:14.000Z (11 months ago)
- Last Synced: 2024-03-15T18:10:28.302Z (8 months ago)
- Language: Python
- Size: 28.3 KB
- Stars: 60
- Watchers: 4
- Forks: 32
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![PyPI](https://img.shields.io/pypi/v/mkdocs-with-confluence)
[![Build Status](https://app.travis-ci.com/pawelsikora/mkdocs-with-confluence.svg?token=Nxwjs6L2kEPqZeJARZzo&branch=main)](https://app.travis-ci.com/pawelsikora/mkdocs-with-confluence)
[![codecov](https://codecov.io/gh/pawelsikora/mkdocs-with-confluence/branch/master/graph/badge.svg)](https://codecov.io/gh/pawelsikora/mkdocs-with-confluence)
![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-with-confluence)
![GitHub contributors](https://img.shields.io/github/contributors/pawelsikora/mkdocs-with-confluence)
![PyPI - License](https://img.shields.io/pypi/l/mkdocs-with-confluence)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-with-confluence)
# mkdocs-with-confluenceMkDocs 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`:
```yaml
plugins:
- search
- mkdocs-with-confluence
```More information about plugins in the [MkDocs documentation: mkdocs-plugins](https://www.mkdocs.org/user-guide/plugins/).
## Usage
Use following config and adjust it according to your needs:
```yaml
- mkdocs-with-confluence:
host_url: https:///rest/api/content
space:
parent_page_name:
username:
password:
enabled_if_env: MKDOCS_TO_CONFLUENCE
#verbose: true
#debug: true
dryrun: true
```## Parameters:
### Requirements
- md2cf
- mimetypes
- mistune