No description
Find a file
Eric Holscher 62ff40e87b Merge pull request #2 from tqchen/master
Add the support for evaluating embedded reStructured Text
2015-07-28 11:13:06 -07:00
recommonmark Add the support for evaluating embedded reStructued Text 2015-07-27 17:46:37 -07:00
.gitignore Initial commit 2013-08-25 16:45:13 +02:00
license.md Create license.md 2014-10-14 11:32:29 +02:00
README.md More readme cleanup 2015-07-28 11:12:27 -07:00
setup.cfg Add setup.cfg 2015-02-13 11:45:18 -08:00
setup.py Rename the project as recommonmark 2014-12-08 00:25:40 +01:00

recommonmark

A docutils-compatibility bridge to CommonMark derived from remarkdown.

Why a bridge?

Many python tools (mostly for documentation creation) rely on docutils. But docutils only supports a ReStructuredText syntax.

For instance this issue and this StackOverflow question show that there is an interest in allowing docutils to use markdown as an alternative syntax.

Why another bridge to docutils?

recommonmark uses the python implementation of CommonMark while remarkdown implements a stand-alone parser leveraging parsley.

Both output a docutils document tree and provide scripts that leverage docutils for generation of different types of documents.

Acknowledgement

recommonmark is mainly derived from remarkdown by Steve Genoud and leverages the python CommonMark implementation.

It was originally created by Luca Barbato, and is now maintained in the Read the Docs (rtfd) GitHub organization.