Package: m2r
NO MORE UPDATESFeel free to fork and update.Old READMEM2RM2R converts a markdown file including reStructuredText (rst) markups to a valid
rst format.Why another converter?I wanted to write sphinx document in markdown, since it’s widely used now and
easy to write code blocks and lists. However, converters using pandoc or
recommonmark do not support many rst markups and sphinx extensions. For
example, rst’s reference link likesee `ref`_(this is very convenient in
long document in which same link appears multiple times) will be converted to
a code block in HTML likesee<code>ref</code>_, which is not expected.FeaturesBasic markdown and some extensions (see below)inline/block-level raw htmlfenced-code blocktablesfootnotes ([^1])Inline- and Block-level rst markupssingle- and multi-line directives (.. directive::)inline-roles (:code:`print(1)`...)ref-link (see `ref`_)footnotes ([#fn]_)math extension inspired byrecommonmarkSphinx extensionadd markdown support for sphinxmdincludedirective to include markdown from md or rst filesoption to parse relative links into ref and doc directives (m2r_parse_relative_links)Pure python implementationpandoc is not requiredInstallationPython 3.7+ is required.pip install m2rOr,python3 -m pip install m2rUsageCommand Linem2rcommand converts markdown file to rst format.m2r your_document.md [your_document2.md ...]Then you will findyour_document.rstin the same directory.Programmatic UseImportm2r.convertfunction and call it with markdown text.
Then it will return converted text.fromm2rimportconvertrst=convert('# Title\n\nSentence.')print(rst)# Title# =====## Sentence.Or, useparse_from_filefunction to load markdown file and obtain converted
text.fromm2rimportparse_from_fileoutput=parse_from_file('markdown_file.md')This is an example of setup.py to write README in markdown, and publish it to
PyPI as rst format.readme_file=os.path.join(os.path.dirname(os.path.abspath(__file__)),'README.md')try:fromm2rimportparse_from_filereadme=parse_from_file(readme_file)exceptImportError:# m2r may not be installed in user environmentwithopen(readme_file)asf:readme=f.read()setup(...,long_description=readme,...,)Sphinx IntegrationIn your conf.py, add the following lines.extensions=[...,'m2r',]# source_suffix = '.rst'source_suffix=['.rst','.md']Write index.md and runmake html.Whenm2rextension is enabled on sphinx and.mdfile is loaded, m2r
converts to rst and pass to sphinx, not making new.rstfile.mdinclude directiveLike.. include:: filedirective,.. mdinclude:: filedirective inserts
markdown file at the line.Note: do not use.. include:: filedirective to include markdown file even if
in the markdown file, please use.. mdinclude:: fileinstead.RestrictionsIn the rst’s directives, markdown is not available. Please write in rst.Column alignment of tables is not supported. (rst does not support this feature)Heading with overline-and-underline is not supported.Heading with underline is OKRst heading marks are currently hard-coded and unchangeable.H1:=, H2:-, H3:^, H4:~, H5:", H6:#If you find any bug or unexpected behaviour, please report it toIssues.ExampleSeeexample documentandits
source code.I’m using m2r for writing user guide ofWDOM.
So you can see it as another example. ItsHTML is
here, andits
source code is here.Demo editorDemo editor of m2r is available.
If you are interested in m2r, please try it.https://github.com/miyakogi/m2rdemoAcknowledgementm2r is written as an extension ofmistune, which is highly extensible
pure-python markdown parser.
Without the mistune, I couldn’t write this. Thank you!LicenceMIT