VSCode中为Markdown文件添加目录导航

浅辰大大_7070

浅辰大大_7070

2026-08-08

605人浏览

原创

vscode outline 面板仅提供只读导航,不生成实际目录;插入可提交、github 可渲染的 toc 必须用插件(如 markdown all in one),且需手动更新,导出 html 时需设置 offline: true 才能保留侧边目录。

vscode中为markdown文件添加目录导航

VSCode 本身不往 Markdown 文件里插目录,Outline 面板只是侧边导航视图;真要插入可点击、能提交到 Git、GitHub 上也能渲染的 TOC,必须用插件生成静态内容。

为什么 Outline 面板里有标题,但文档里没目录?

Outline 是 VSCode 内置的实时解析视图,只读取 # 开头的 ATX 标题(不支持 === 或 --- 这类 Setext 标题),且完全不写入文件。它不生成任何 Markdown 文本,也不处理 frontmatter 或代码块里的伪标题。所以你看到 Outline 里有层级,不代表文档里已有目录——那是纯 UI 层的导航,不是内容。

  • # 标题 前有空格或 tab 缩进超过 1 个 → Outline 可能跳过,更不会进 TOC
  • 用了全角 #(U+FF03)代替 ASCII # → 完全不识别
  • 标题含未转义 HTML,如 # <div>说明</div> → 解析中断,后续标题错位

用 Markdown All in One 插入可提交的 TOC

这是目前最稳定、中文兼容性最好的方案。安装后无需额外配置,默认就能处理中文标题和常见符号。

Markdown Converter 1.0.0
Markdown Converter 1.0.0

使用 markitdown 将文档和文件转换为 Markdown。适用于转换 PDF、Word (.docx)、PowerPoint (.pptx)、Excel (.xlsx, .xls)、HTML、CSV、JSON、XML 等格式。

下载
  • 确保文件后缀是 .md 或 .markdown,且右下角状态栏语言模式为 Markdown
  • 光标放在想插入目录的位置(通常在文件开头或 ## 目录 下一行)
  • 按 Ctrl+Shift+P(macOS 为 Cmd+Shift+P),输入 Create Table of Contents 并执行
  • 生成的链接形如 - [简介](#简介),锚点自动 URL 编码,GitHub 渲染正常

注意:markdown.extension.toc.levels 控制包含几级标题(默认 2-6),若只要 ## 和 ###,可设为 "2-3"。

导出 HTML 时侧边目录消失?关键在 offline: true

如果你用 Markdown Preview Enhanced 导出 HTML 后发现左侧 TOC 不见了,不是插件坏了,而是资源没打包进去。

  • 必须在文档顶部加 frontmatter,且严格顶格、无空行:
    ---<br>html:<br>  toc: true<br>  html_config:<br>    offline: true<br>---
  • offline: true 是核心——它把所有 JS/CSS/图标全内联进 HTML,不再依赖网络或本地路径
  • 漏掉这行,导出的 HTML 会尝试加载外部脚本,而这些脚本在离线打开时 404,侧边栏直接空白

真正容易被忽略的是:TOC 插入后不会自动更新。结构改了就得删掉旧 TOC,再手动跑一次 Create Table of Contents。没有“监听保存自动刷新”这种事——它生成的是静态文本,不是活的组件。

相关文章

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

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

下载

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

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1275

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2652

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1909

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2587

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

454

5

热门下载

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

精品课程

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