Skip to main content

Connect Markdown Renderer

Project description

CloudBlue Connect Markdown Renderer

pyversions PyPi Status Build Status codecov Quality Gate Status


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


connect-markdown-renderer can be installed from 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


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



This code will produce the following output:

Console markdown


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.


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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

connect-markdown-renderer-2.0.1.tar.gz (11.0 kB view hashes)

Uploaded Source

Built Distribution

connect_markdown_renderer-2.0.1-py3-none-any.whl (11.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page