Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.13 KB

README.md

File metadata and controls

31 lines (19 loc) · 1.13 KB

remarkdown

A markdown parser based on docutils

Note that this code is still alpha, some markdown features might not work yet

Why another markdown library?

remarkdown is not just only another markdown library. It mostly contains a parser that outputs a docutils document tree. The different scripts bundled then use docutils for generation of different types of documents.

Why is this important? 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.

Acknowledgement

The remarkdown PEG is heavily inspired by peg-markdown by John MacFarlane.