1Misaka
2======
3
4.. image:: https://img.shields.io/pypi/v/misaka.svg
5    :target: https://pypi.python.org/pypi/misaka
6
7.. image:: https://img.shields.io/pypi/dm/misaka.svg
8    :target: https://pypi.python.org/pypi/misaka
9
10.. image:: https://img.shields.io/travis/FSX/misaka.svg
11    :target: https://travis-ci.org/FSX/misaka
12
13A CFFI binding for Hoedown_ (version 3), a markdown parsing library.
14
15Documentation can be found at: http://misaka.61924.nl/
16
17.. _Hoedown: https://github.com/hoedown/hoedown
18
19
20Installation
21------------
22
23Misaka has been tested on CPython 2.7, 3.2, 3.4, 3.5, 3.6, 3.7 and PyPy 2.7 and 3.5.
24It needs CFFI 1.0 or newer, because of this it will not work on PyPy 2.5 and older.
25
26With pip::
27
28    pip install misaka
29
30Or manually::
31
32    python setup.py install
33
34
35Example
36-------
37
38Very simple example:
39
40.. code:: python
41
42    import misaka as m
43    print m.html('some other text')
44
45Or:
46
47.. code:: python
48
49    from misaka import Markdown, HtmlRenderer
50
51    rndr = HtmlRenderer()
52    md = Markdown(rndr)
53
54    print(md('some text'))
55