mdown 2018.11.20

markdown generator

Install

$ [sudo] pip install mdown

Functions

function	description
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'

readme-md - README.md generator