0

0

Sublime如何为Markdown文件生成目录 (TOC)? (插件实现)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-12 13:23:31

|

936人浏览过

|

来源于php中文网

原创

Sublime Text 需通过 Table of Contents 插件生成 Markdown 目录,安装后重启,确保文件为 .md 后缀且含 # 标题,调用 TOC: Insert Table of Contents 命令插入;需配置 min_depth=1 才包含一级标题。

sublime如何为markdown文件生成目录 (toc)? (插件实现)

Sublime Text 本身不内置 Markdown 目录生成功能,但通过 MarkdownPreview 或更专注的 Table of Contents 插件可以稳定实现——后者专为 TOC 设计,支持实时更新、点击跳转和多级标题识别,推荐优先使用。

安装 Table of Contents 插件(最简路径)

该插件由 thomaspark 维护,兼容 Sublime Text 3/4,无需额外依赖:

  • 打开命令面板(Ctrl+Shift+P / Cmd+Shift+P),输入 Package Control: Install Package
  • 搜索并安装 Table of Contents(注意名称精确,不是 Markdown TOC 或其他变体)
  • 安装后重启 Sublime(部分版本需手动重启才加载命令)

生成 TOC 的正确触发方式

插件不会自动插入目录,必须显式调用;且仅对当前文件类型为 Markdown 时生效(即右下角状态栏显示 Markdown,而非 Plain text):

玫瑰克隆工具
玫瑰克隆工具

AI图文笔记一键生成创作并自动发布助手

下载
  • 确保文件已保存为 .md.markdown 后缀
  • 将光标置于想插入 TOC 的位置(通常在文档顶部或 # 概述 下方)
  • 再次打开命令面板,输入 TOC: Insert Table of Contents 并回车
  • 默认生成的 TOC 使用 [title](#heading-id) 形式,与 GitHub/GitLab 渲染完全兼容

常见失效原因与修复

生成失败通常不是插件问题,而是环境或操作细节未满足:

  • Command not found:说明插件未正确安装或未启用,检查 Preferences → Package Settings → Table of Contents 是否存在
  • 生成内容为空或只有 #:确认文档中至少有一个以 # 开头的标题行(注意空格),且无缩进或前置字符
  • 链接无法跳转:Sublime 原生不解析锚点,需配合 MarkdownPreview 插件在浏览器中预览,或使用支持内联预览的插件如 Markmap
  • 中文标题 ID 不规范:插件默认将中文转为 ASCII(如 ## 项目结构#%E9%A1%B9%E7%9B%AE%E7%BB%93%E6%9E%84),若需可读 ID,需在插件设置中开启 "slugify": true 并配置 slugify_mode
{
    "slugify": true,
    "slugify_mode": "github"
}

插件默认忽略 h1#)级别标题,只从 h2##)开始生成;如果需要包含一级标题,必须修改插件用户配置里的 "min_depth" 值为 1——这个细节几乎没人主动查,但直接影响 TOC 完整性。

相关专题

更多
常见的编码方式
常见的编码方式

常见的编码方式有ASCII编码、Unicode编码、UTF-8编码、UTF-16编码、GBK编码等。想了解更多编码方式相关内容,可以阅读本专题下面的文章。

583

2023.10.24

a和A对应的ASCII码数值
a和A对应的ASCII码数值

a的ascii码是65,a的ascii码是97;ascii码表中,一个字母的大小写数值相差32,一般知道大写字母的ascii码数值,其对应的小写字母的ascii码数值就算出来了,是大写字母的ascii码数值“+32”。想了解更多相关的内容,可阅读本专题下面的相关文章。

2109

2024.10.24

c语言编程软件有哪些
c语言编程软件有哪些

c语言编程软件有GCC、Clang、Microsoft Visual Studio、Eclipse、NetBeans、Dev-C++、Code::Blocks、KDevelop、Sublime Text和Atom。更多关于c语言编程软件的问题详情请看本专题的文章。php中文网欢迎大家前来学习。

586

2023.11.02

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

18

2026.01.13

PHP 高性能
PHP 高性能

本专题整合了PHP高性能相关教程大全,阅读专题下面的文章了解更多详细内容。

34

2026.01.13

MySQL数据库报错常见问题及解决方法大全
MySQL数据库报错常见问题及解决方法大全

本专题整合了MySQL数据库报错常见问题及解决方法,阅读专题下面的文章了解更多详细内容。

19

2026.01.13

PHP 文件上传
PHP 文件上传

本专题整合了PHP实现文件上传相关教程,阅读专题下面的文章了解更多详细内容。

16

2026.01.13

PHP缓存策略教程大全
PHP缓存策略教程大全

本专题整合了PHP缓存相关教程,阅读专题下面的文章了解更多详细内容。

6

2026.01.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Markdown标记语言快速入门
Markdown标记语言快速入门

共30课时 | 3.4万人学习

vscode常用插件与markdown语法介绍
vscode常用插件与markdown语法介绍

共10课时 | 1.2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号