https://github.com/openedx/mdrst

Markdown-to-RST Cheatsheet Maker
https://github.com/openedx/mdrst

Last synced: about 1 month ago
JSON representation

Markdown-to-RST Cheatsheet Maker

• Host: GitHub
• URL: https://github.com/openedx/mdrst
• Owner: openedx
• License: apache-2.0
• Created: 2018-12-21T21:12:35.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-14T16:53:18.000Z (over 1 year ago)
• Last Synced: 2024-04-09T23:10:51.642Z (9 months ago)
• Language: Python
• Size: 67.4 KB
• Stars: 9
• Watchers: 74
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
################################

Markdown-to-RST Cheatsheet Maker

################################

Open edX uses ReStructured Text (RST) for its documentation.  People have told

us they are unfamiliar with RST, and that a comparison of the two would be

welcome.

The cheatsheet: `mdrst.rst`_.

In this repo are two files: `md.md`_ and `rst.rst`_.  They have parallel

heading structures, each showing how their format represents each construct.

Together, they produce `mdrst.rst`_, which shows the examples side-by-side.

The convert.py tool reads those two files, and produces:

* md.html, the HTML output from md.md.

* rst.html, the HTML output from rst.rst.

* mdrst.rst, the source for the side-by-side comparison.

* mdrst.html, the HTML output from mdrst.rst.

To run the tool::

   $ python3.8 -m pip install -r requirements.txt

   $ python3.8 convert.py

.. _md.md: https://github.com/openedx/mdrst/blob/master/md.md

.. _rst.rst: https://github.com/openedx/mdrst/blob/master/rst.rst

.. _mdrst.rst: https://github.com/openedx/mdrst/blob/master/mdrst.rst