Skip to content

目录页配置

目录页配置

警告

目录页数据来源于 vitepress-plugin-catalogue 插件实现,如果禁用了该插件,目录页将不会生效。

目录页本质上是一个 Markdown 文档,通过在 frontmatter 配置 layout: truecatalogue: true 来开启目录页功能,因此可以与其他文档一起放到任意目录下。

sh
.

├─ 01.指南
  00.目录.md
  ├─ 01.指南 - 使用
   00.目录.md
  ├── 04.使用 - 登录认证.md
  ├── 07.使用 - 权限认证.md
  ├─ 05.指南 - 环境集成
   00.目录.md
  ├── 04.环境集成 - Spring Boot.md
  ├── 07.环境集成 - Spring WebFlux.md
  ├── 99.环境集成 - 上下文组件开发指南.md
├─ 05.设计
  00.目录.md
  ├─ 01.设计 - 思路
  01.设计 - 思路设计.md
  ├─ 03.设计 - Helpers
  ├── 01.设计 - Helpers 说明.md
sh
.

├─ 00.目录页
  01.指南 - 目录.md
  05.使用 - 目录.md
  10.环境集成 - 目录.md
  15.设计 - 目录.md
├─ 01.指南
  ├─ 01.指南 - 使用
  ├── 04.使用 - 登录认证.md
  ├── 07.使用 - 权限认证.md
  ├─ 05.指南 - 环境集成
  ├── 04.环境集成 - Spring Boot.md
  ├── 07.环境集成 - Spring WebFlux.md
  ├── 99.环境集成 - 上下文组件开发指南.md
├─ 05.设计
  ├─ 01.设计 - 思路
  01.设计 - 思路设计.md
  ├─ 03.设计 - Helpers
  ├── 01.设计 - Helpers 说明.md

目录页的 frontmatter 配置如下:

yaml
---
title: 设计 - 知识体系 # 页面标题
date: 2025-01-30 20:27:48 # 创建时间
permalink: /design # 永久链接
layout: page # page 布局(必填)
catalogue: true # 目录页(必填)
path: 05.设计 # 设置为根目录下的某个文件夹相对路径(必填)
desc: Hd Security 设计思路 # 目录描述
pageTitle: 设计体系目录 # 页面标题,默认为目录
sidebar: false # 不显示侧边栏
---

提示

配置好目录页之后,点击文章页的面包屑将会跳转到目录页。