首页
/ Vitepress侧边栏目录层级配置指南

Vitepress侧边栏目录层级配置指南

2025-05-15 23:44:51作者:温玫谨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)

常见配置方案:

  1. [2, 6](默认值):只显示h2到h6标题
  2. [1, 3]:显示h1到h3标题
  3. [1, 6]:显示所有级别的标题

实际应用建议

  1. 技术文档:建议保持默认的[2,6]配置,因为h1通常用作页面主标题
  2. 知识库系统:可考虑[1,4]配置,既展示主要结构又不至于太冗长
  3. 教学材料:使用[1,6]完整展示所有层级,方便定位细节内容

注意事项

  1. 过度显示高层级标题可能导致目录过于冗长
  2. 在移动端视图中,过深的层级可能影响阅读体验
  3. 建议保持文档结构的一致性,避免混合使用过多不同层级的标题

通过合理配置目录层级,可以显著提升文档的可读性和导航效率,是Vitepress项目优化的重要一环。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
23
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
225
2.27 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
flutter_flutterflutter_flutter
暂无简介
Dart
526
116
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
987
583
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
351
1.42 K
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
61
17
GLM-4.6GLM-4.6
GLM-4.6在GLM-4.5基础上全面升级:200K超长上下文窗口支持复杂任务,代码性能大幅提升,前端页面生成更优。推理能力增强且支持工具调用,智能体表现更出色,写作风格更贴合人类偏好。八项公开基准测试显示其全面超越GLM-4.5,比肩DeepSeek-V3.1-Terminus等国内外领先模型。【此简介由AI生成】
Jinja
47
0
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
JavaScript
212
287