VitePress-05-文档中标题表toc的使用

说明

本文介绍一下标题表的使用。

什么是标题表

所谓的标题表，就是 当前文档的所有标题的一个集合,就是当前文档的一个快速索引。
它和标题锚点的作用类似，可以快速的定位到某个标题。

标题表的使用语法

标题表的语法是固定的 ：[[toc]]
只要写上，就会展示出当前文档中标题列表

注意 ：
默认情况下，标题表只会展示第二级 和 第三级 的标题,
如果想修改这个配置，请阅读下一小结。

标题表的自定义配置

vitepress 的配置中提供了对 markdown 的自定义配置的功能，
针对 标题表 toc 同样也提供了自定义配置的入口。
本小结主要介绍 标题表的层级的配置，使标题表支持 第一级 、第二级、 第三级 标题。

配置很简单，只需要在 vitepress 的配置文件中添加如下配置即可：

import { defineConfig } from 'vitepress'
export default defineConfig({
// 对 markdown 的配置
 markdown:{
   toc: {
     level: [1,2,3], // 指定标题的层级
   }
 }
})

使用案例

文档内容

[[toc]]

# 一级标题-01
> hello world for vitepress

# 一级标题-02
> hello world for vitepress - 02

## 2.1 二级标题-01
> hello toc 

### 2.1.1 第一个三级标题
> hello 

#### 这是个四级标题，不会被展示
> 这个四级标题不会被展示

### 2.1.2 第二个三级标题
> hello 

## 2.2 二级标题-02

效果展示

原文地址：https://blog.csdn.net/qq_39505245/article/details/135922047

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！