要实现自动生成文档目录,必须明确选择markdowntoc或table of contents插件:前者需手动配置中文锚点,后者开箱即用且对中文更友好;安装后务必重启sublime text,确保文件语法识别为markdown,并正确配置uri_encoding与slugify参数。

装错名字就完全没反应,MarkdownTOC 和 Table of Contents 是两个插件,功能重叠但配置、行为、中文支持差异很大——你要的“自动生成文档目录”,得先明确用哪个。
认准插件名:不是 MarkdownToc,也不是 AutoTOC
Package Control 里搜 toc 会出来一堆结果,但只有两个主流可选:MarkdownTOC(作者 jonschlinkert)和 Table of Contents(作者 thomaspark)。前者更老、参数多、需手动配中文锚点;后者开箱即用、对中文标题更友好、命令面板直接可搜到。
- 装
MarkdownTOC后默认不绑定快捷键,按Ctrl+Shift+P输入MarkdownTOC: Insert/Update才能触发 - 装
Table of Contents后命令是TOC: Insert Table of Contents,且支持光标在 TOC 块内时直接TOC: Update - 名字拼错(比如
MarkdownToc少大写、MarkDownTOC混大小写)会导致命令不加载,重启也无效
安装后必须重启 Sublime Text
尤其是 Sublime Text 4,插件安装完不重启,命令面板里根本搜不到对应命令——这不是延迟问题,是插件模块根本没加载进内存。
- Windows/Linux:关闭所有 ST 窗口,再重新打开
- macOS:不仅关窗口,还要在 Dock 中右键图标 → “退出”,否则后台进程仍在运行
- 验证是否生效:打开一个
.md文件,Ctrl+Shift+P输入插件命令关键词,看是否出现在候选列表中
文件类型必须是 Markdown,不是 Plain text
右下角状态栏显示 Plain text 或空白?那插件压根不会响应。它只对语法识别为 Markdown 的文件起作用。
- 点击右下角语言名,手动选择
Markdown;或按Ctrl+Shift+P输入Set Syntax: Markdown - 确保文件已保存为
.md或.markdown后缀,未保存的临时文件常被识别为 Plain text - 如果始终识别失败,检查是否装了冲突插件(如旧版
Markdown官方包),可临时禁用测试
中文标题生成链接失败?关键是 uri_encoding 和 slugify
MarkdownTOC 默认生成的锚点是 URI 编码格式,比如 #%E7%AE%80%E4%BB%8B,部分浏览器或预览插件不兼容;而 Table of Contents 默认就用原始中文锚点(如 #简介),无需额外配置。
- 若坚持用
MarkdownTOC,必须编辑其配置:Preferences → Package Settings → MarkdownTOC → Settings - 写入:
"uri_encoding": false+"slugify": true+"slugify_mode": "github" - 注意:
"auto_reload": true只在保存时更新 TOC,且要求 TOC 区块连续(前后不能有空行),否则更新失败
真正卡住人的地方不在安装步骤,而在「插件加载了但命令不出现」和「生成了目录但点击跳转失败」——前者多半是没重启或语法类型不对,后者几乎全是 uri_encoding 或 slugify 配置遗漏。别跳过验证环节。











