Skip to main content

markdown generator

Project description

Installation

$ [sudo] pip install mdown

Functions

function __doc__
mdown.code(code, language=None) return string with markdown code block
mdown.header(title, lvl) return string with markdown header
mdown.image(url, link='', title='', alt='') return string with markdown image
mdown.table(headers, matrix) return string with markdown table (one-line cells only)

Examples

header

>>> import mdown
>>> mdown.header("title", 6)
'###### Title'

code

>>> mdown.code("$ [sudo] pip install readme_md", "bash")
# look Install section :)

image

>>> mdown.image("https://domain.com/image.png", title="title text", alt="alt text")
'![alt text](https://domain.com/image.png "title text")'

table

>>> mdown.table(("header1","header2"),(("cell11","cell12"), ("cell21","cell22")))
'header1|header2
-|-
cell11|cell12
cell21|cell22'

python-readme-generator

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

mdown-2019.4.13.tar.gz (2.1 kB view hashes)

Uploaded source

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