Convert RST to MD
Turn RST files into Markdown. GitHub Markdown with the title, author and other fields in a YAML block at the top.
Converted in an isolated sandbox on our serversDeleted after 24 hours
Drop RST files on the dialor turn it to pick what to do
Sphinx docs as GitHub Markdown.Titles and authors move into a YAML block. Admonitions become alerts.
What you get
One MD file in GitHub Markdown. The title, the author and other fields from the RST file go into a YAML block at the top of the file.
Admonitions become alerts, so a note or a warning in the RST shows as an alert on GitHub.
What changes
Roles become code. A role such as a cross-reference is written as inline code in the Markdown.
Directives that only Sphinx knows keep just their text, placed in an HTML block. The directive itself does not run, so anything it would have built is not in the output.
Comments are dropped. Text that was only a comment in the RST is not in the Markdown file.
Going the other way
To turn Markdown back into RST, use MD to RST. To see other options for this format, there is a page for every MD conversion.
RST and MD.What each format is.
The formats
reStructuredText
reStructuredText, the markup of Python documentation and Sphinx.
- Extensions
- .rst
- MIME type
- text
/x -rst - Kind
- Text and data
Markdown
Plain text with light markup for headings, lists, links and code. What agents and developers write in.
- Extensions
- .md .markdown .mdown
- MIME type
- text
/markdown - Kind
- Text and data
In your code.The same RST to MD conversion through the API, for your app or your agent.
$ cv convert report.rst report.md$ cv convert report.rst report.mdQuestions.What people ask about RST to MD.
They go into a YAML block at the top of the Markdown file, along with the other fields.
Yes. They become alerts in the Markdown.
They keep only their text, which is placed in an HTML block. Whatever the directive would have generated is not included.
No. Comments in the RST are dropped.