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

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

2025-05-15 11:31:09作者:温玫谨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项目优化的重要一环。

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

项目优选

收起
docsdocs
暂无描述
Dockerfile
702
4.51 K
pytorchpytorch
Ascend Extension for PyTorch
Python
566
693
atomcodeatomcode
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get Started
Rust
546
98
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
957
955
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
411
338
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.6 K
940
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.08 K
566
AscendNPU-IRAscendNPU-IR
AscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优
C++
128
210
flutter_flutterflutter_flutter
暂无简介
Dart
948
235
Oohos_react_native
React Native鸿蒙化仓库
C++
340
387