添加 Markdown
输入或打开需要迁移的文档。
Markdown 转 reStructuredText
把常见 Markdown 结构转换为 RST 源文本，作为 Sphinx 或 docutils 项目的迁移起点。
Markdown 输入
86 字符
RST 预览
项目笔记
====
清晰的文档从**明确的结构**开始。
检查重点
----
* 层级清楚的标题
* 可以正常打开的链接
* 便于继续编辑的文件
下载前先检查渲染预览。
文件在当前浏览器标签页中处理。
如何把 Markdown 转成 RST
转换后请在项目实际使用的 Sphinx 配置中构建。
检查 RST 源码
重点核对标题下划线、列表缩进、代码指令和链接。
复制或下载 .rst
加入项目后运行 Sphinx 构建，修复警告和专用指令。
RST 源输出
为 Sphinx 文档保留基本结构
转换器处理通用文档元素，不替代项目专用指令。
标题层级用 RST 常见的下划线字符表示标题层级。
列表和代码转换项目符号、编号列表和代码块。
链接与强调将常见链接、粗体和斜体改写为 RST 语法。
常见用途
把 Markdown 带入 Python 文档体系
Sphinx 文档
迁移教程、概念说明和 API 周边文字。
Python 项目
将 Markdown 说明转换为项目要求的 .rst 文件。
docutils 管线
为依赖 RST 的发布工具准备可继续调整的源文件。
常见问题
Markdown 转 RST 常见问题
RST 和 reStructuredText 是同一个东西吗？
是，RST 是 reStructuredText 的常用简称，文件扩展名通常为 .rst。
可以直接生成完整 Sphinx 项目吗？
不可以。工具生成单个 RST 内容，项目配置、主题和构建环境仍需自行准备。
标题为什么用不同下划线？
RST 通过装饰字符区分标题层级。转换后应确认字符选择与项目现有规范一致。