为VuePress自动生成侧边栏分组的插件

Github:https://github.com/shanyuhai123/vuepress-plugin-auto-sidebar
文档:https://shanyuhai123.github.io/vuepress-plugin-auto-sidebar/

插件的可选项:https://shanyuhai123.github.io/vuepress-plugin-auto-sidebar/features/plugin-options.html
精准排序:https://shanyuhai123.github.io/vuepress-plugin-auto-sidebar/features/markdown-file-config.html#精准排序
多个分组:https://shanyuhai123.github.io/vuepress-plugin-auto-sidebar/features/markdown-file-config.html#多个分组

module.exports = {
  plugins: {
    "vuepress-plugin-auto-sidebar": {
      collapsable: true,
      sidebarDepth: 2,
    }
  }
}

常见问题:侧边栏显示的是文件路径,而非文件名

这是由于 md 文件中缺乏标题导致的,标题的产生有两种方式:

(1)添加 Front Matter 的 title 属性(推荐)

---
title: 标题
---

(2)markdown 语法中的标题

# 一级标题
## 二级标题

文件名如何嵌套多级标题

注:title 属性相当于一级标题,如果设置 title 属性,正文应以二级标题为最顶级标题

配置全局的 depth,如果你希望配置某个文件的 depth 修改文件内的 sidebarDepth

版权声明:
作者:Joe.Ye
链接:https://www.appblog.cn/index.php/2023/03/25/a-plugin-for-automatically-generating-sidebar-groups-for-vuepress/
来源:APP全栈技术分享
文章版权归作者所有,未经允许请勿转载。

THE END
分享
二维码
打赏
海报
为VuePress自动生成侧边栏分组的插件
Github:https://github.com/shanyuhai123/vuepress-plugin-auto-sidebar 文档:https://shanyuhai123.github.io/vuepress-plugin-auto-sidebar/ 插件的可选项……
<<上一篇
下一篇>>
文章目录
关闭
目 录