File: README.rst

package info (click to toggle)
python-misaka 1.0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,092 kB
  • ctags: 942
  • sloc: ansic: 3,690; python: 631; sh: 53; makefile: 21
file content (37 lines) | stat: -rw-r--r-- 568 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Misaka
======

.. image:: https://secure.travis-ci.org/FSX/misaka.png?branch=master

The Python binding for Sundown_, a markdown parsing library.

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

.. _Sundown: https://github.com/tanoku/sundown


Installation
------------

Cython is needed to compile Misaka.

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')