rst2md is a custom writer for Python's Docutils document processing system which converts reStructuredText documents to Markdown.
Note: This project was a simple proof of concept. It's not complete or ready for production in any sense.
rst2md is released under the permissive BSD 2-Clause License, see the file LICENSE for the license text.
Currently there is not an installation script. The most straightforward way to get rst2md.py working is to:
-
ensure that Docutils is installed,
-
copy, move or link the file markdown.py, located in the repository root directory, to docutils/writiers/ in the standard Docutils package and the file rst2md.py, located under tools/, to anywhere on your PATH (or PYTHONPATH).
Comments and enhancements are very welcome.
Report any issues or feature requests on the GitHub bug
tracker. Please include a minimal
(not-) working example which reproduces the bug and, if appropriate, the
Docutils traceback information (obtained by running rst2md.py with the
--traceback option). Please do not request features already being worked
towards (see the TODO file).
Code contributions are encouraged: please feel free to fork the project and submit pull requests.