RETIRED, further work has moved to Debian project infrastructure
Go to file
Frank Smit 7d95f452a8 Add requirements.txt 2015-07-14 12:51:39 +02:00
benchmark Reorganize. 2015-06-08 16:26:41 +02:00
docs Add examples and started documentating the API. 2015-07-14 00:56:13 +02:00
misaka Add examples and started documentating the API. 2015-07-14 00:56:13 +02:00
scripts Update misaka script. 2015-06-27 15:49:43 +02:00
tests Automatically discover tests. 2015-07-13 17:23:28 +02:00
.gitignore Custom renderer works. 2015-06-27 11:26:14 +02:00
.travis.yml Remove wercker and disable PyPy for Travis CI. 2015-07-10 15:26:57 +02:00
LICENSE.txt Use CFFI for Hoedown binding. 2015-06-02 15:03:44 +02:00
MANIFEST.in Remove trailing slashes 2012-03-08 21:57:38 +01:00
README.rst Typo. 2015-07-10 19:17:15 +02:00
THANKS Add remaining render callbacks. 2015-06-03 00:04:24 +02:00
build_ffi.py Add Smartypants. 2015-06-27 15:00:59 +02:00
requirements.txt Add requirements.txt 2015-07-14 12:51:39 +02:00
setup.py Remove clean command from setup.py. 2015-07-12 13:05:16 +02:00

README.rst

Misaka

image

image

image

A CFFI binding for Hoedown (version 3), a markdown parsing library.

Documentation can be found at: http://misaka.61924.nl/

Installation

Misaka has been tested on CPython 2.7, 3.2, 3.3, 3.4 and PyPy 2.6. It needs CFFI 1.0 or newer, because of this it will not work on PyPy 2.5 and older.

With pip:

pip install misaka

Or manually:

python setup.py install

Example

Very simple example:

from misaka import Markdown, HtmlRenderer

rndr = HtmlRenderer()
md = Markdown(rndr)

print md.render('some text')

Or:

import misaka as m
print m.html('some other text')