The converter recognizes underline and overline RST headings, inline RST links, literal blocks introduced by double colon syntax, and numbered list markers using a closing parenthesis. These patterns are rewritten into Markdown headings, links, fenced code blocks, and numbered lists.
reStructuredText has many directive and table forms that are project-specific. This converter keeps unsupported lines readable instead of trying to infer every Sphinx extension, so review directives, tables, substitutions, and custom roles by hand.
Common questions and answers about this topic.
reStructuredText (rst) is a lightweight markup language commonly used in Python documentation and Sphinx-based projects.
The converter rewrites underline and overline headings, inline links, literal blocks, and numbered list markers written as `1)`. Tables, directives, substitutions, and custom roles are preserved as text and should be reviewed manually.
Common use cases include migrating Sphinx documentation to MkDocs, GitHub wikis, or any Markdown-based documentation platform.
No, the reStructuredText to Markdown conversion runs entirely in your browser. Your document is converted locally with JavaScript and never uploaded.