https://github.com/hhatto/python-hoedown

The Python binding for hoedown, a markdown parsing library.
https://github.com/hhatto/python-hoedown

Last synced: about 1 month ago
JSON representation

The Python binding for hoedown, a markdown parsing library.

• Host: GitHub
• URL: https://github.com/hhatto/python-hoedown
• Owner: hhatto
• License: mit
• Created: 2013-10-11T21:13:56.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2018-10-11T12:46:06.000Z (about 6 years ago)
• Last Synced: 2024-10-12T19:49:28.361Z (about 1 month ago)
• Language: HTML
• Size: 355 KB
• Stars: 52
• Watchers: 6
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
python-hoedown

==============

.. image:: https://img.shields.io/pypi/v/hoedown.svg

    :target: https://pypi.org/project/hoedown/

    :alt: PyPI Version

.. image:: https://secure.travis-ci.org/hhatto/python-hoedown.png?branch=master

    :target: https://travis-ci.org/hhatto/python-hoedown

The Python binding for hoedown_, a markdown parsing library.

the original code of the misaka_ library by Frank Smit.

.. _hoedown: https://github.com/hoedown/hoedown

.. _misaka: https://github.com/FSX/misaka

Installation

------------

Cython is only needed to compile .pyx file.

With pip::

    pip install hoedown

Or manually::

    python setup.py install

Example

-------

Very simple example::

    from hoedown import Markdown, HtmlRenderer

    rndr = HtmlRenderer()

    md = Markdown(rndr)

    print md.render('some text')

Or::

    import hoedown as m

    print m.html('some other text')

Command Line Tool

-----------------

output from Markdown to HTML::

    hoedownpy MARKDOWNFILE.md

For Maintainer

--------------

intall development requirements::

    pip install -e ".[dev]"

build::

    invoke all