Metadata-Version: 2.1
Name: connect-markdown-renderer
Version: 1.0.1
Summary: CloudBlue Connect Terminal Markdown Renderer
Home-page: https://connect.cloudblue.com
Author: CloudBlue
License: UNKNOWN
Keywords: markdown ansi fulfillment command line interface utility cli vendor connect cloudblue
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: ansicolors (<2,>=1.1.8)
Requires-Dist: mistune (==0.8.4)
Requires-Dist: pygments (>=2.7.1<3)

# CloudBlue Connect Markdown Renderer


![pyversions](https://img.shields.io/pypi/pyversions/connect-markdown-renderer.svg) [![PyPi Status](https://img.shields.io/pypi/v/connect-markdown-renderer.svg)](https://pypi.org/project/connect-markdown-renderer/) [![Build Status](https://github.com/cloudblue/connect-markdown-renderer/workflows/Build%20Connect%20Markdown%20Renderer/badge.svg)](https://github.com/cloudblue/connect-markdown-renderer/actions) [![codecov](https://codecov.io/gh/cloudblue/connect-markdown-renderer/branch/master/graph/badge.svg)](https://codecov.io/gh/cloudblue/connect-markdown-renderer)


## Introduction

`connect-markdown-renderer` is a small library that allow to render markdown documents in a terminal shell.

## Requirements

`connect-markdown-renderer` requires Python 3.6+ and depends on the following libraries:

* ansicolors>=1.1.8,<2
* mistune==0.8.4
* pygments>=2.7.1<3



## Install

`connect-markdown-renderer` can be installed from pypi.org with pip:

```sh

$ pip install connect-markdown-renderer

```

## Usage example

```python

from cmr import render

my_md = """

# Heading level 1 - Paragraph

This is a paragraph.

## Heading level 2 - Lists

*Ordered list:*

1. First item
2. Second item
3. Third item


**Unordered list:**

* First
* Second
* Third

"""

print(render(my_md))

```

This code will produce the following output:

![Console markdown](screenshot_1.png)



## Limitations

`connect-markdown-renderer` does not support:

* Inline HTML
* Footnotes


## License

`connect-markdown-renderer` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

