Sublime Text插件无统一文档系统,Package Settings仅提供配置模板无说明,命令面板搜Documentation大多无效,最可靠方式是通过Browse Packages进入插件目录查看README.md或访问GitHub主页获取权威文档。

Sublime Text 没有内置的、统一的“插件文档系统”——所谓“自带帮助”,其实是零散入口,得靠你主动找对地方,否则根本看不到文档。
Package Settings 里只有配置项,不是文档
很多人打开 Preferences → Package Settings → GitGutter → Settings,以为右侧 JSON 就是文档。其实它只是配置模板:没说明每个字段含义,也不解释行为边界。比如 "live_mode" 开关到底影响什么?默认值怎么生效?这些全靠猜或翻 GitHub。
- 左侧文件(Default)是只读的,改了也没用
- 右侧文件(User)只管覆盖,不提供上下文解释
- 若插件没注册
Package Settings菜单项(比如某些手动丢进Packages/的脚本),这个路径压根不会出现
命令面板搜 “Documentation” 大多无效
不少插件声称支持 Package Control: Documentation 或 PluginName: Show Documentation,但实际能响应的极少。截至 2026 年 5 月,只有 DashDoc、LSP、WordCount 等少数插件实现了该命令;其余多数会静默失败,或弹出空窗口。
- 搜不到别硬试,先查插件 GitHub 主页的 README 是否写了支持该命令
- 命令面板输入
Documentation后无匹配项,基本等于“该插件没做这功能” - 部分插件把文档藏在
Help子菜单里(如 GitGutter 有GitGutter: Help),但命名不统一,没法穷举
直接进 Packages 目录看 README.md 最可靠
90% 的插件作者会在源码根目录放 README.md 或 docs/,这是最原始也最完整的文档来源。关键是要进对目录:
- 菜单栏点
Preferences → Browse Packages…,打开的是用户插件目录(Packages/) - 找到对应插件文件夹(如
Emmet、LSP),直接双击打开,看有没有README.md、CHANGELOG.md或docs/子目录 - 如果只看到
.sublime-package文件(比如GitGutter.sublime-package),说明插件未解压,需先装PackageResourceViewer,再用命令面板执行PackageResourceViewer: Open Resource才能浏览内容
GitHub 是唯一权威文档源,但得会查
Package Control 网站上每个插件详情页都带 “Homepage” 链接,点进去基本就是 GitHub。这里要注意三点:
- 别只看
main分支的 README —— 很多插件已迁到dev或v4分支,旧文档可能过时 - 搜索框输
settings或configuration,比通读全文快得多 - Issues 区常有用户踩坑记录,比如 “
show_hover不生效”,答案往往比 Wiki 还及时
真正卡住的时候,不是找不到文档,而是误信某个入口是“官方通道”;实际上 Sublime 的插件生态里,GitHub README 才是事实标准,其他都是衍生品。











