无需登录 数据私有 本地保存

Markdown 转 reStructuredText 工具

11
0
0
0

Markdown → reStructuredText

在线将 Markdown 文档转换为 reStructuredText (rST) 格式，支持 Sphinx / Docutils

实时转换
字符: 0 | 行: 0
Markdown 输入 Ctrl+Enter 转换
reStructuredText 输出 等待输入

常见问题与知识点

什么是 reStructuredText (rST)？

reStructuredText 是 Python 社区广泛使用的轻量级标记语言，由 Docutils 项目定义。它是 Sphinx 文档生成器的默认格式，广泛用于 Python 官方文档、Read the Docs 等技术文档平台。rST 语法比 Markdown 更严格、更强大，支持指令（directives）、角色（roles）、交叉引用等高级特性。

Markdown 和 reStructuredText 的主要区别是什么？

设计哲学不同：Markdown 追求简洁易读，rST 追求功能完整与可扩展性。标题语法：Markdown 使用 # 前缀，rST 使用下划线/上划线装饰。代码块：Markdown 使用围栏式 ```，rST 使用 .. code-block:: 指令。链接：Markdown 使用 [text](url)，rST 使用 `text <url>`_。扩展性：rST 拥有强大的指令系统（如 .. note::、.. warning::），Markdown 依赖变体扩展。

为什么需要将 Markdown 转换为 reStructuredText？

如果您正在使用 Sphinx 构建文档、向 Python 项目贡献文档、或者需要在 Read the Docs 上发布，通常需要 rST 格式。将现有的 Markdown 文档转换为 rST 可以复用已有内容，避免手动重新排版。此外，rST 对复杂文档结构（如交叉引用、术语表、索引）的支持更完善。

这个转换工具支持哪些 Markdown 语法？

支持标准 Markdown 和 GFM 扩展：标题（h1-h6）、粗体/斜体、行内代码、围栏式代码块（含语言标识）、无序/有序列表（含嵌套）、引用块、链接（内联式与引用式）、图片、水平线、表格。部分高级特性（如脚注、任务列表、定义列表）转换可能不完美，建议转换后人工校对。

转换结果的局限性有哪些？

由于两种格式的设计差异，某些元素无法完美映射：① Markdown 的引用式链接会被展开为内联链接；② GFM 的删除线（~~text~~）在标准 rST 中无直接对应，将原样保留；③ HTML 标签在 rST 中通常不被支持，需手动替换为对应指令；④ 复杂的嵌套表格可能需要手动调整列宽。建议将转换结果作为起点，根据实际需求进行微调。

reStructuredText 标题装饰线的规则是什么？

rST 标题使用装饰字符（=、-、~、^、"、' 等）标注层级。装饰线长度必须与标题文本等长。本工具默认映射：h1 → 上下 = 线、h2 → 下方 = 线、h3 → 下方 - 线、h4 → 下方 ~ 线、h5 → 下方 ^ 线、h6 → 下方 " 线。您可以根据实际文档约定调整装饰字符。

Sphinx 与 reStructuredText 的关系是什么？

Sphinx 是基于 Docutils 的文档生成工具，原生使用 rST 作为标记语言。Sphinx 扩展了 rST 的指令集，添加了 .. toctree::、.. automodule::、:ref: 等特有语法。本工具生成的是标准 rST，可被 Sphinx 直接识别和渲染。

如何在命令行中批量转换 Markdown 到 rST？

如果需要批量转换，推荐使用 Pandoc：pandoc input.md -o output.rst。Pandoc 支持更全面的语法覆盖和自定义模板。本在线工具适合快速单篇转换、预览和学习两种格式的语法对照。

🔧 相关工具