Skip to main content

CloudBlue Connect Terminal Markdown Renderer

Project description

CloudBlue Connect Markdown Renderer

pyversions PyPi Status Build Status codecov

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:

$ pip install connect-markdown-renderer

Usage example

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

Limitations

connect-markdown-renderer does not support:

  • Inline HTML
  • Footnotes

License

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.

Files for connect-markdown-renderer, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size connect_markdown_renderer-1.0.1-py3-none-any.whl (13.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size connect-markdown-renderer-1.0.1.tar.gz (152.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page