# 侧边栏重要

侧边栏处在页面左边,作为目录使用,点击目录可以跳转到相应的标题下。

导航栏菜单相当于给文章分类,每个分类下都有不同的侧边栏(或者说目录)。

提示

当然,要是为了简洁,不弄侧边栏也是可以的。但就需要把所有的文章放导航栏的下拉列表里,显得比较拥挤。

# 侧边栏配置

下面介绍如何配置侧边栏,以基础教程(/course/)栏目为例:

// .vuepress/config.js
module.exports = {
    themeConfig: {
        sidebar: {
          '/course/': [
            {
              title: '基础教程',   // 一级菜单名称
              collapsable: false,
              sidebarDepth: 2,
              children: [ //配置标题
                ['','主要内容'], 
                ['directory_structure.md','项目框架'],
                ['grammar.md','基础语法'],
                ['navigation_bar.md','导航栏'],
                ['sidebar.md','侧边栏'],
              ]
            }
          ],
        },
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

侧边栏在themeConfig.sidebar中配置。以基础教程(/course/)为例(上述代码第5-18行),当在导航栏中点击基础教程时,跳转到我们之前所配置的/course/路径。而在侧边栏中,我们将配置/course/路径下的文件。

第5行中,用/course/表示我们要配置的侧边栏的路径。之后的title表示侧边栏目录的大标题。collapsable表示是否折叠,默认为true表示折叠。sidebarDepth表示侧边栏目录的深度,不用深入了解。


1. title :目录大标题

之后在children中配置子文件,代表这些文件的标题将会被配置为/course/下的侧边栏目录,点击侧边栏相应的标题会跳转到对应的文章。

首先是入口文件README.md,之前讲过,它不需要显式地指定,因此用''表示便可(代码第11行),然后用方括号括起来,再在后面指定这篇文章的标题。

比如本篇文章sidebar.md,路径为/course/sidebar.md,只需把它放在/course/下面,然后指定文章的标题便可。

提示

配置的标题都是文章的大标题,文章中的小标题不用我们自己在侧边栏中配置,系统会帮我们自动生成。

2. 自动生成的小标题

# 自动生成侧边栏

如果你希望自动生成一个仅仅包含了当前页面标题的侧边栏,你可以将下面这段YAML front matter代码写在想要自动生成目录的 md 文件最上方:

---
sidebar: auto
---
1
2
3

提示

顺带一提,仅仅包含了当前页面标题的侧边栏指的是侧边栏目录中只有当前文章的目录,其他文章的目录则消失了。虽然方便,但最好在该栏目只有一篇文章的情况下使用。

// .vuepress/config.js
module.exports = {
  themeConfig: {
    sidebar: 'auto'
  }
}
1
2
3
4
5
6

# 禁用侧边栏

如果你希望页面简洁一些,可以在特定文章中不使用侧边栏目录。同样,将代码写在 md 文件的最上方。

---
sidebar: false
---
1
2
3



TIP

好了,现在所有的基本知识点都已经讲解完了,赶紧去试试自己搭建一个博客吧~

如果对某些知识点还是一知半解的话,可以在主页下方评论区留言,或者点击右上角导航栏的Github链接,将代码下载下来查看。

不要忘记点一个 star 哦~



上次更新时间: a month ago