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

VSCode配置Markdown目录:一键生成侧边栏与文档索引技巧

小瑶吖_8847

小瑶吖_8847

发布时间:2026-04-15 11:55:25

|

1321人浏览过

|

来源于php中文网

原创

VSCode侧边栏大纲(Outline)默认不启用,需手动开启explorer.experimental.showOutline和markdown.preview.toc两项设置才能显示标题结构化导航树。

vscode配置markdown目录:一键生成侧边栏与文档索引技巧

VSCode侧边栏大纲(Outline)能直接显示目录,但默认不启用

VSCode自带的“大纲”面板就是最轻量的侧边目录,但它不会自动弹出来,也不默认解析所有Markdown文件的标题结构。关键在两个设置是否打开:explorer.experimental.showOutline 和 markdown.preview.toc。

必须手动开启,否则侧边栏永远只显示“EXPLORER”“SEARCH”等常规标签,看不到标题树。

  • explorer.experimental.showOutline 控制大纲是否出现在侧边栏——设为 true 才会出现“OUTLINE”标签
  • markdown.preview.toc 决定预览窗口里是否渲染右侧浮动TOC(非侧边栏,是预览区内的小目录),它不影响侧边栏,但常被误认为是同一功能
  • 仅开启 outline.automaticCollapse 为 false 不够,没开 showOutline 就根本没这个面板

用 Markdown All in One 插件生成文档内可点击的 TOC 行

侧边栏大纲只是导航索引,不嵌入文档本身;如果需要把目录写进 .md 文件顶部、支持 GitHub 渲染或导出 HTML,就得生成实际的 Markdown 列表行。

Markdown All in One 是目前最稳定的选择,它不依赖 Pandoc 或外部服务,命令执行快,中文标题锚点转换也可靠(如 ## 中文标题 → [中文标题](#中文标题))。

  • 光标放在想插入的位置(通常是文件开头或 [toc] 标记处),按 Ctrl+Shift+P 输入 Markdown: Create Table of Contents
  • 生成的链接默认使用 github-slug 规则:空格变-,中文转 URL 编码(如 %E4%B8%AD%E6%96%87),标点被剔除
  • 不支持自动更新——改了标题后,旧目录不会同步变,必须手动再运行一次命令
  • 若想保存时自动重生成,需在插件设置里打开 markdown.extension.toc.autoUpdate

docsify 侧边栏 TOC 需要独立服务,不是 VSCode 原生能力

很多人搜“VSCode Markdown 侧边目录”,实际想要的是像 Typora 那样左边固定导航栏、右边滚动内容的效果。VSCode 做不到——它的预览是单页只读视图,没有左侧菜单区。

Markdown-UI DSL: Zero-Hallucination UI Generation
Markdown-UI DSL: Zero-Hallucination UI Generation

使用 Markdown-UI DSL 创建低保真文本线框图。

下载

真要这种体验,必须起一个本地 HTTP 服务,用 docsify 动态渲染。这不是配置问题,而是架构差异:VSCode 是编辑器,docsify 是浏览器端渲染器。

  • _sidebar.md 必须和 index.html 同级,且文件名带下划线,否则 docsify 加载失败,控制台报 404 /_sidebar.md
  • 文档里至少要有两个 ## 或更高级别标题,# 一级标题默认不进 TOC
  • npx docsify serve . 启动后访问 http://localhost:3000,VSCode 只负责编辑,刷新靠浏览器自动完成
  • 别试图用 Live Server 插件打开 index.html——它不加载 _sidebar.md,也不执行 docsify 的 JS 初始化逻辑

中文标题锚点失效?先确认你用的是哪个渲染环境

同一个中文标题,在不同地方生成的锚点可能完全不同:VSCode 预览、GitHub、docsify、导出的 HTML,各自处理规则不一致。这不是 bug,是规范差异。

例如 ## 数据库连接配置:

  • VSCode 内置预览用的是 database-connection-configuration(拼音转小写短横)
  • GitHub 用的是 数据库连接配置(原样 URL 编码,即 %E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5%E9%85%8D%E7%BD%AE)
  • docsify 默认用 github-slug,行为接近 VSCode,但可配成 gitlab 或 cjk 模式
  • 如果你手写链接如 [跳转](#数据库连接配置),只在 GitHub 有效;写成 [跳转](#database-connection-configuration),才在 VSCode 预览和 docsify 里生效

跨平台兼容性要求高的场景,别依赖自动生成的锚点格式,要么统一用英文标题,要么在生成后手动校验跳转目标是否真实存在。

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

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

立刻MV
立刻MV Hot

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

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

相关专题

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

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

1255

2023.06.30

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

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

2612

2023.07.21

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

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

1889

2024.03.14

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

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

1707

2024.03.14

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

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

2587

2024.03.15

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

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

1798

2024.03.15

vscode用途介绍
vscode用途介绍

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

1242

2024.03.15

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

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

1096

2024.03.15

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

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

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