Vitepress侧边栏目录层级配置指南
2025-05-15 22:52:11作者:温玫谨Lighthearted
Vitepress作为Vue.js官方推出的静态站点生成器,其默认主题提供了灵活的目录展示功能。本文将深入讲解如何配置右侧目录(outline)的标题显示层级,帮助开发者更好地组织文档结构。
目录层级的基本原理
Vitepress的右侧目录(outline)默认显示h2到h6级别的标题,这种设计考虑了大多数文档的结构需求。但实际项目中,我们可能需要调整这个范围来满足不同的文档组织需求。
配置方法详解
在Vitepress配置文件中,可以通过themeConfig.outline属性来控制目录显示范围:
// .vitepress/config.js
export default {
themeConfig: {
outline: {
level: [1, 6] // 显示h1到h6所有级别的标题
}
}
}
层级配置选项说明
level参数接受一个包含两个数字的数组:
- 第一个数字表示起始级别(最小为1,对应h1)
- 第二个数字表示结束级别(最大为6,对应h6)
常见配置方案:
[2, 6](默认值):只显示h2到h6标题[1, 3]:显示h1到h3标题[1, 6]:显示所有级别的标题
实际应用建议
- 技术文档:建议保持默认的[2,6]配置,因为h1通常用作页面主标题
- 知识库系统:可考虑[1,4]配置,既展示主要结构又不至于太冗长
- 教学材料:使用[1,6]完整展示所有层级,方便定位细节内容
注意事项
- 过度显示高层级标题可能导致目录过于冗长
- 在移动端视图中,过深的层级可能影响阅读体验
- 建议保持文档结构的一致性,避免混合使用过多不同层级的标题
通过合理配置目录层级,可以显著提升文档的可读性和导航效率,是Vitepress项目优化的重要一环。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C092
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python058
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
AgentCPM-Explore没有万亿参数的算力堆砌,没有百万级数据的暴力灌入,清华大学自然语言处理实验室、中国人民大学、面壁智能与 OpenBMB 开源社区联合研发的 AgentCPM-Explore 智能体模型基于仅 4B 参数的模型,在深度探索类任务上取得同尺寸模型 SOTA、越级赶上甚至超越 8B 级 SOTA 模型、比肩部分 30B 级以上和闭源大模型的效果,真正让大模型的长程任务处理能力有望部署于端侧。Jinja00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
474
3.54 K
React Native鸿蒙化仓库
JavaScript
287
339
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
224
92
Ascend Extension for PyTorch
Python
283
316
暂无简介
Dart
723
174
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
849
441
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
699
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19