https://github.com/sgenoud/remarkdown

A markdown parser for docutils
https://github.com/sgenoud/remarkdown

Last synced: about 1 month ago
JSON representation

A markdown parser for docutils

• Host: GitHub
• URL: https://github.com/sgenoud/remarkdown
• Owner: sgenoud
• License: mit
• Created: 2013-08-25T14:46:04.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-10-14T09:32:29.000Z (about 10 years ago)
• Last Synced: 2024-10-31T22:32:16.463Z (about 1 month ago)
• Language: Python
• Size: 133 KB
• Stars: 132
• Watchers: 7
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

• starred-awesome - remarkdown - A markdown parser for docutils (Python)

README

        
# 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][docutils]. 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][sphinx-issue] and [this StackOverflow

question][so-question] show that there is an interest in allowing `docutils` to

use markdown as an alternative syntax.

[docutils]: http://docutils.sourceforge.net/docs/ref/doctree.html

[sphinx-issue]: https://bitbucket.org/birkenfeld/sphinx/issue/825/markdown-capable-sphinx

[so-question]: http://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-instead-of-rst

## Acknowledgement

The remarkdown PEG is heavily inspired by [peg-markdown by John

MacFarlane][peg-md].

[peg-md]: https://github.com/jgm/peg-markdown