This converter turns Markdown into reStructuredText for Sphinx, Read the Docs and PyPI: headings with underlines, code-block directives, grid tables, admonitions and footnotes. Paste a README.md and copy the .rst.
Last updated:
How it works
Paste Markdown
Paste a README or docs page, open a .md file or load the sample.
Pick the conventions
Heading underline characters, code directive, table style and link style.
Use the .rst
Download README.rst or paste the text into your Sphinx project.
Features
Valid section structure
RST derives levels from the order of underline styles, so skipped Markdown levels are compacted to avoid “Title level inconsistent”.
Directives, not hacks
Code becomes .. code-block:: python, notes become .. note:: or .. warning::, math .. math::.
Three table styles
Grid tables, simple tables or the list-table directive, which is easiest to edit.
Inline markup rules handled
Escaped spaces are inserted where RST needs whitespace around **bold** or `links`__.
Limits & privacy
Files up to 10 MB. Inputs above 256 KB are converted in a Web Worker, so the page stays responsive. Nothing is uploaded: the conversion runs in your browser, and Open from URL fetches the file directly from the address you enter. See the privacy page.
Differences to keep in mind
reStructuredText has no strikethrough or underline: such text stays plain. Hard line breaks become line blocks (| lines). A transition (––) cannot start or end a document and is dropped there. Grid and simple tables have no column alignment.
FAQ
How do I convert README.md to README.rst?
Open the README.md here and download the result as README.rst. Check the warnings for things RST cannot express.
Does PyPI still need RST?
No, PyPI renders Markdown too, but Sphinx projects and many older tools expect reStructuredText.
Why is bold inside a link lost?
reStructuredText cannot nest inline markup. The link text is kept, the inner formatting is dropped with a warning.
How are images inside text written?
Inline images use substitutions: |name| in the text and a .. |name| image:: definition at the end.
Can I convert RST back to Markdown?
Yes, with RST → Markdown, linked above the result.