No description
Find a file
Eric Holscher ed63d9afbb Merge pull request #7 from tqchen/master
Auto Directive generation
2015-08-04 09:24:58 -07:00
docs checkin the other docs 2015-08-03 22:37:07 -07:00
recommonmark self document. 2015-08-03 22:34:32 -07:00
.gitignore add configuration from doc.env 2015-08-02 17:54:06 -07:00
license.md Create license.md 2014-10-14 11:32:29 +02:00
README.md Small readme cleanup 2015-07-28 11:15:59 -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.

This allows you to write CommonMark inside of Docutils & Sphinx projects.

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.