51工具盒子

依楼听风雨
笑看云卷云舒,淡观潮起潮落

vuepress如何生成目录

# vuepress 如何生成目录 {#vuepress-如何生成目录}

本文讲述 vuepress 静态网站中自动生成文章目录的步骤。

# 定义的位置 {#定义的位置}

文档正文起始处加入一行如下内容, 即可自动为当前文档生成目录。


注意

是正文起始处。frontmatter 部分可不算正文哦!

# heading-标题的定义规范 {#heading-标题的定义规范}

h1 标题很特殊,既不参与生成目录,也不参与生成侧边栏。所以我们就可以定义 1 个统一的标题应用规范,见heading 标题的定义规范

# 目录的层次深度 {#目录的层次深度}

修改配置文件 config.js

module.exports = {
  title: "王世彪的博客",
  description: "王世彪的博客, 干货满满",

  markdown: {
    toc: {
        includeLevel:[1, 2, 3, 4]
    }
  }
};

提示

includeLevel 默认值为[2, 3], 所以默认不显示一级标题

赞(2)
未经允许不得转载:工具盒子 » vuepress如何生成目录