转换器会识别 underline / overline RST heading、inline RST link、由 double colon 语法开启的 literal block,以及右括号形式的编号列表。这些 pattern 会被改写成 Markdown heading、link、fenced code block 与编号列表。
reStructuredText 有许多 directive 与 table 写法会因项目而异。这个转换器会让未支持的行保持可读,而不是猜测所有 Sphinx extension;directive、table、substitution 与 custom role 仍应人工检查。
关于这个主题的常见疑问与实用解答。
reStructuredText(rst)是一种轻量级标记语言,常用于 Python 文档与 Sphinx 项目中。
转换器会改写 underline / overline heading、inline link、literal block,以及 `1)` 形式的编号列表。表格、directive、substitution 与 custom role 会以文字保留,需人工检查。
常见场景包括将 Sphinx 文档迁移到 MkDocs、GitHub Wiki 或其他基于 Markdown 的文档平台。
不会,reStructuredText 转 Markdown 的转换完全在您的浏览器中执行。您的文档通过 JavaScript 在本地转换,不会被上传。