目录页配置

什么是目录页？可以在本文章最上方的面包屑里点击 指南查看效果。

警告

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

目录页本质上是一个 Markdown 文档，因此可以与其他文档一起放到任意目录下，如：

当前文件夹

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

专门创建目录页文件夹

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

有两种方式可以开启目录页：

1. 在 frontmatter配置 catalogue:true和 layout:page来开启目录页
2. 在 frontmatter配置 catalogue:true和 layout:TkCataloguePage来开启目录页

目录页的 frontmatter配置如下：

方式 1

---catalogue:truelayout:pagepath:05.设计desc:Hd Security 设计思路pageTitle:设计体系目录sidebar:falsearticle:false---

方式 1 带注释

---catalogue:true# 目录页（必填）layout:page# page 布局（必填）path:05.设计# 设置为根目录下的某个文件夹相对路径（必填）desc:Hd Security 设计思路# 目录描述pageTitle:设计体系目录# 页面标题，默认为目录sidebar:false# 不显示侧边栏article:false# 不显示在首页的文章列表和归档页---

方式 2

---catalogue:truelayout:TkCataloguePagepath:05.设计desc:Hd Security 设计思路pageTitle:设计体系目录sidebar:falsearticle:false---

方式 2 带注释

---catalogue:true# 目录页（必填）layout:TkCataloguePage# TkCataloguePage 布局（必填）path:05.设计# 设置为根目录下的某个文件夹相对路径（必填）desc:Hd Security 设计思路# 目录描述pageTitle:设计体系目录# 页面标题，默认为目录sidebar:false# 不显示侧边栏article:false# 不显示在首页的文章列表和归档页---

提示

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