CloudBlue Connect Markdown Renderer

Introduction

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

Install

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

$ pip install connect-markdown-renderer

Usage example

from connect.utils.terminal.markdown import render

my_md = """

# Heading level 1 - Paragraph

This is a paragraph with inline formatting like *italic*, **strong**, ~~strikethrough~~, `inline code` and :clapping_hands: emojis!.

## Heading level 2 - Lists

*Ordered list:*

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

**Unordered list:**

* First
* Second
* Third

### Heading level 3 - blockquote

> This is a blockquote.
> > ...and a nested blockquote.


#### Heading level 4 - tables

| Col 1 | Col 2 | Col 3 |
|:------|:-----:|------:|
| a | b | c |


##### Heading level 5 - codeblock


```python

def this_is_my_python_function(args):
    return 'Hello World!'


"""

print(render(my_md))

This code will produce the following output:

Features

connect-markdown-renderer uses the new markdown-it-py parser and supports CommonMark plus the following extensions:

• tables
• strikethrough
• emoji

connect-markdown-renderer uses rich to render the markdown in the terminal.

License

connect-markdown-renderer is released under the Apache License Version 2.0.