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.

Files for mdown, version 2019.4.13
Filename, size File type Python version Upload date Hashes
Filename, size mdown-2019.4.13.tar.gz (2.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page