构建结构化站点的核心配置和约定
# 构建结构化站点的核心配置和约定
本主题遵循“约定优于配置”原则,如果你想构建一个结构化的站点,需要遵循下面这些约定,约定可以为你省去很多配置,轻松拥有一个结构清晰的站点。
你需要在config.js
中有如下配置:
// config.js
module.exports = {
themeConfig: {
sidebar: 'structuring' // 'structuring' | { mode: 'structuring', collapsable: Boolean} | 'auto' | 自定义
}
}
1
2
3
4
5
6
2
3
4
5
6
在运行开发服务npm run dev
或打包npm run build
时主题内部将会按照目录约定自动生成一个结构化的侧边栏、目录页、面包屑等数据。
在源目录(一般是docs
)文件夹中,除了.vuepress
、@pages
、_posts
、index.md
或 README.md
之外的文件夹将会为其生成对应的侧边栏。生成的顺序取自序号,标题取自文件(夹)名称。
# 命名约定
- 无论是文件还是文件夹,请为其名称添加上正确的正整数序号和
.
,从00
或01
开始累计,如01.文件夹
、02.文件.md
,我们将会按照序号的顺序来决定其在侧边栏当中的顺序。 - 同一级别目录别内即使只有一个文件或文件夹也要为其加上序号。
- 文件或文件夹名称中间不能出现多余的点
.
,如01.我是.名称.md
中间出现.将会导致解析错误。
提示
序号只是用于决定先后顺序,并不一定需要连着,如01、02、03...
,实际工作中可能会在两个文章中间插入一篇新的文章,因此为了方便可以采用间隔序号10、20、30...
,后面如果需要在10
和20
中间插入一篇新文章,可以给定序号15
。
# 级别说明
源目录(一般是docs
)底下的级别现在我们称之为一级目录,一级目录的下一级为二级目录,以此类推,最多到四级目录。
- 一级目录
- .vuepress、@pages、_posts、index.md 或 README.md 这些文件(文件夹)不参与数据生成。
- 序号非必须。(如一些专栏,可以不用序号)
- 二级目录
- 该级别下可以同时放文件夹和.md文件,但是两者序号要连贯(参考下面的例子中的其他)。
- 必须有序号
- 三级目录
- (同上)
- 四级目录 v1.6.0 +
- 该级别下只能放.md文件。
- 必须有序号
所有级别内至少有一个文件或文件夹。