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

夏萱大大_4049

夏萱大大_4049

2026-01-12

1036人浏览

原创

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):

git-push
git-push

自动用 git 提交代码并推送到远程仓库。当用户输入 `/gitpush` 时触发此技能。功能包括:自动暂存所有更改、自动生成提交信息、自动提交到本地仓库、自动推送到远程分支。成功后报告提交状态、文件数量和耗时。

下载
  • 确保文件已保存为 .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 完整性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.10.24

1548

7

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

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

2024.10.24

5767

11

github中文官网入口 github中文版官网网页进入
github中文官网入口 github中文版官网网页进入

github中文官网入口https://docs.github.com/zh/get-started,GitHub 是一种基于云的平台,可在其中存储、共享并与他人一起编写代码。 通过将代码存储在GitHub 上的“存储库”中,你可以: “展示或共享”你的工作。 持续“跟踪和管理”对代码的更改。

2026.01.21

8925

27

GitHub官网入口版本汇总
GitHub官网入口版本汇总

本专题整合了GitHub入口版本地址汇总,阅读专题下面的文章了解更多详细内容。

2026.04.02

1018

19

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

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

2023.11.02

9999

18

Sublime Text全方位使用指南
Sublime Text全方位使用指南

本专题深入剖析Sublime Text的环境配置与脚本开发机制,涵盖从 v3 升级 v4 实践、Shell 与 YAML 语法支持、Console 控制台调试到 Conda 多环境切换等核心操作,并详细讲解 Python 插件编写及构建系统(Build Systems)定制,旨在帮助开发者通过深度定制与脚本驱动,实现自动化代码格式化及跨语言高效开发。

2026.04.13

311

22

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

100

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

60

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

60

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程