sublime text 不支持 restructuredtext 同步预览,需手动用 rst2html.py 生成 html 并浏览器打开;推荐配置 build system 实现一键构建,而非依赖已停更、兼容性差的 rst preview 插件。

Sublime Text 本身不支持 reStructuredText(RST)预览,也没有官方维护的 RST Preview 插件;所谓“同步预览”必须放弃幻想,改用手动触发 + 浏览器 file:// 协议打开的组合方案,否则你会卡在空白页、解析失败或命令面板搜不到命令这三步里。
为什么找不到 RST Preview 命令?
Sublime 没有像 MarkdownPreview 那样成熟、持续维护的 RST 渲染插件。你搜到的 RstPreview、reStructuredText Preview 等插件大多已停更(最后更新在 2018–2020 年),与 ST4 兼容性差,安装后命令面板不显示、右键菜单无响应是常态。
- Package Control 中搜
rst或restructuredtext,返回结果基本是语法高亮插件(如RestructuredText),它只负责着色,不生成 HTML,也不开浏览器 -
RstPreview插件依赖旧版docutilsCLI 工具,且硬编码调用rst2html.py,在 Python 3.9+ 和 Windows 路径含空格时大概率报FileNotFoundError - 即使插件装上,也常因 Sublime 的
exec模块权限限制,无法正确捕获rst2html输出,导致预览窗口为空白
替代方案:用 rst2html 手动构建 + 浏览器刷新
最稳的方式是绕过插件,直接用系统级 rst2html 命令生成 HTML,再用浏览器打开——这不是“自动同步”,但可控、无兼容风险、每次都能看到真实渲染结果。
- 先确保已安装
docutils:pip install docutils(推荐用 Python 3.8–3.12,避免 3.13+ 的 API 变更影响rst2html) - 确认命令可用:
rst2html.py --version,输出应为docutils 0.21.x或更高 - 在 Sublime 中保存 RST 文件(如
index.rst),然后终端执行:rst2html.py index.rst index.html - 用浏览器打开生成的
index.html(必须用 file:// 协议,不要双击——某些浏览器会禁用本地脚本;建议拖入 Chrome 或 Firefox 标签页) - 后续编辑只需重复执行
rst2html.py+ 切换浏览器按F5,比依赖插件更可靠
想绑定快捷键?别用插件,改用 Build System
Sublime 的 Build System 可以把 rst2html 封装成一键命令,比插件更轻量、更易调试。
- 菜单栏选
Tools → Build System → New Build System… - 粘贴以下内容并保存为
RST HTML.sublime-build:
{
"cmd": ["rst2html.py", "$file", "$file_path/${file_base_name}.html"],
"selector": "text.restructuredtext",
"working_dir": "$file_path",
"variants": [
{
"name": "Open in Browser",
"cmd": ["rst2html.py", "$file", "$file_path/${file_base_name}.html"],
"shell": true,
"windows": {
"cmd": ["cmd.exe", "/c", "rst2html.py", "$file", "$file_path/${file_base_name}.html"]
}
}
]
}
- 保存后,右下角状态栏确认文件被识别为
reStructuredText(不是 Plain text 或 RST GFM) - 按
Ctrl+B运行构建,生成 HTML;再按Ctrl+Shift+P输入Open File,选刚生成的.html文件,或直接用文件管理器双击打开 - 该 Build System 不依赖任何插件,不卡顿、不崩溃、不冲突,且可随时查看终端输出排错
真正难的不是“怎么让 Sublime 自动预览 RST”,而是接受它根本不适合做这事——Sphinx + VS Code 才是 RST 文档的标准工作流;在 Sublime 里,手动构建 + F5 刷新就是目前最接近“可用”的边界。











