讲师中心 微信公众号
AI工具推荐 视频效率加速

Sublime Text中利用MarkdownTOC生成文档目录

老萱吖_3238

老萱吖_3238

发布时间:2026-07-02 10:16:24

|

902人浏览过

|

来源于php中文网

原创

MarkdownTOC插件必须准确拼写为“MarkdownTOC”(作者jonschlinkert),装错如“MarkdownToc”将导致命令不可用、配置不显示;安装后需重启Sublime Text,文件类型须为Markdown且含合法#标题;中文锚点需配置"slugify":true、"slugify_mode":"github"、"uri_encoding":false;目录层级由"base_level"控制,默认1即包含#标题;"auto_reload":true仅在保存时触发更新,且TOC块须连续无空行。

sublime text中利用markdowntoc生成文档目录

MarkdownTOC 插件名必须拼写准确,不能少字母或换顺序

装错插件是生成失败最常见的原因。Package Control 里搜 toc 会出来一堆名字相近的包:MarkdownTOC、MarkdownToc、AutoTOC、Table of Contents——只有 MarkdownTOC(作者 jonschlinkert)能稳定支持中文 slugify 和自动更新。装错一个字母,比如 MarkdownToc,按快捷键完全没反应,配置项也根本不会出现。

安装后必须重启 Sublime Text,否则命令面板里搜不到 MarkdownTOC: Insert/Update。

  • 确认已安装:打开 Preferences → Package Settings → MarkdownTOC,能看到菜单说明已生效
  • 文件类型必须是 Markdown:右下角状态栏显示 Markdown,不是 Plain text 或 Text
  • 文件需有合法标题:至少一行以 # 开头,且前面无空格或其它字符( # 标题 或 1. # 标题 都不识别)

中文标题链接点不开?关键是 slugify 和 uri_encoding 的组合设置

默认生成的链接像 [简介](#%E7%AE%80%E4%BB%8B),浏览器能解码,但 GitHub、GitLab、Obsidian 等多数渲染器只认短横线格式 [简介](#jian-jie)。点不开不是插件 bug,是 ID 格式不匹配。

必须在 Preferences → Package Settings → MarkdownTOC → Settings – User 中显式配置:

Telegram Markdown Adapter
Telegram Markdown Adapter

将 Markdown 格式的回复转换为适合 Telegram 的富文本,避免渲染错误。适用于用户偏好 Markdown 但目标平台为 Telegram 的场景。

下载
{
  "slugify": true,
  "slugify_mode": "github",
  "uri_encoding": false
}
  • "slugify": true 启用中文转拼音+短横线(如 ## 数据处理流程 → data-chuli-liu-cheng)
  • "slugify_mode": "github" 严格遵循 GitHub 的锚点规则:去标点、小写、空格/中文全转短横线
  • "uri_encoding": false 关闭 URI 编码,避免生成 %E5%BC%95%E8%A8%80 类 ID,否则和 slugify 冲突

为什么只生成 ## 及以下,漏掉 # 一级标题?min_depth 和 base_level 不是一回事

Table of Contents 插件用 min_depth 控制最小包含层级;而 MarkdownTOC 用 base_level 重定义“一级”的起始位置。两者参数名不同、作用逻辑也不同,混用会失效。

想让 # 项目概述 出现在目录第一层,必须设:

{
  "base_level": 1
}
  • "base_level": 1 表示把 # 当作目录一级(默认值就是 1,一般不用改)
  • "base_level": 2 表示把 ## 当作一级,### 当二级——适合文档开头已有固定封面标题时
  • 别和 min_depth 搞混:min_depth 是 Table of Contents 插件的参数,MarkdownTOC 不识别它

自动更新目录不生效?检查 auto_reload 和保存动作是否触发

"auto_reload": true 的意思是“保存文件时自动刷新目录”,不是“实时监听编辑”。很多人改完标题就等着目录变,结果没反应——因为还没 Ctrl+S。

  • 确保配置中启用了 "auto_reload": true(默认是 false)
  • 修改标题后必须手动保存文件,插件才会重新解析并覆盖旧 TOC
  • 如果目录被手动删过,auto_reload 不会重建,得再执行一次 MarkdownTOC: Insert/Update
  • 更新范围仅限当前光标所在位置的 TOC 块,不会动其他段落

最易忽略的一点:TOC 必须是连续的 Markdown 列表块(以 - 或 1. 开头),中间不能插入空行或其它内容,否则 Update 会失败或只更新前半部分。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

40

2026.10.16

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

40

2026.10.16

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

20

2026.10.16

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

20

2026.10.16

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

20

2026.10.16

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

40

2026.10.15

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

40

2026.10.15

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

20

2026.10.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn