主题配置
# 主题配置
主题的配置在.vuepress/config.js
文件的themeConfig
字段中,是在原有配置的基础上新增或修改的配置,配置示例请查看:config.js
# 是否打开分类、标签、归档
# category
- 类型:
boolean
- 默认值:
true
是否打开分类功能。 如打开,会做的事情有:
- 自动生成的front matter包含分类字段
- 页面中显示与分类相关的信息和模块
- 自动生成分类页面(在@pages文件夹)
如关闭,则反之。
# tag
- 类型:
boolean
- 默认值:
true
是否打开标签功能。 如打开,会做的事情有:
- 自动生成的front matter包含标签字段
- 页面中显示与标签相关的信息和模块
- 自动生成标签页面(在@pages文件夹)
如关闭,则反之。
# archive
- 类型:
boolean
- 默认值:
true
是否打开归档功能。 如打开,会做的事情有:
- 自动生成归档页面(在@pages文件夹)
如关闭,则反之。
# 使用分类页、标签页、归档页链接
当你打开了分类
、标签
、归档
功能,就可以在导航或其他地方添加分类页、标签页、归档页的链接:
- 分类页:
/categories/
- 标签页:
/tags/
- 归档页:
/archives/
# 碎片化博文默认分类值
# categoryText
碎片化博文(_posts文件夹的文章)默认生成的分类值
- 类型:string
- 默认值:'随笔'
# body背景大图
# bodyBgImg
body
背景大图,单张图片使用String
,多张图片使用Array
, 多张图片时每隔15
秒换一张
- 类型:
string
|array
- 默认值:
undefined
# bodyBgImgOpacity
body背景图透明度
- 类型:
number
- 默认值:
0.5
- 选值范围:
0 ~ 1.0
# 文章标题前的图标
# titleBadge
是否打开文章标题图标
- 类型:
boolean
- 默认值:
true
# titleBadgeIcons
文章标题图标的地址
- 类型:
array
- 默认值:
内置图标
# 文章内容块的背景底纹
# contentBgStyle
文章内容块的背景底纹
- 类型:
number
- 默认值:
undefined
- 选值:
1 => 方格
|2 => 横线
|3 => 竖线
|4 => 左斜线
|5 => 右斜线
|6 => 点状
# 侧边栏
# sidebar
- 类型:
srting
|object
|array
- 在默认主题原有的配置上新增两项参数:
'structuring'
自动生成结构化侧边栏{ mode: 'structuring', collapsable: Boolean}
自动生成结构化侧边栏,并设置侧边栏是否可折叠,默认true
提示
如需构建结构化站点请把此配置设置为structuring
或 { mode: 'structuring', collapsable: false}
# sidebarOpen
初始状态下是否打开侧边栏
- 类型:
boolean
- 默认值:
true
提示
在侧边栏关闭状态下,页面向下滚动时会隐藏顶部导航栏,让用户更专注于阅读。
# 对指定页面禁用侧边栏
你可以通过 front matter
来禁用指定页面的侧边栏:
---
sidebar: false
---
2
3
# 对指定页面禁用侧边栏
在_posts
文件夹的文章会自动在 front matter
添加 sidebar: auto
---
sidebar: auto
---
2
3
# 最近更新栏
# updateBar
最近更新栏,显示于文章页底部和简约版首页文章列表
- 类型:
object
- 默认值:
{showToArticle: true, moreArticle: '/archives/'}
showToArticle
: 显示到文章页底部,默认true
moreArticle
: “更多文章”跳转的页面,默认'/archives/'
# 非文章页的设置
对于非文章页,如目录页、关于、友情链接等自定义页面,最好在front matter
设置article: false
,设置之后这个页面将被认定为非文章页,不显示面包屑和作者、时间,不显示最近更新栏,不会参与到最近更新文章的数据计算中。
---
article: false
---
2
3
# 右侧文章大纲栏
# rightMenuBar
是否显示右侧文章大纲栏。设置为false
或屏宽小于1300px
时,文章大纲将与左侧侧边栏混合在一起。 (注:在屏宽小于1300px
下无论如何都不显示右侧文章大纲栏。)
- 类型:
boolean
- 默认值:
true
# 快捷翻页按钮
# pageButton
是否显示快捷翻页按钮 (此按钮是文章页左右两边的箭头按钮,小屏中不会显示。)
- 类型:
boolean
- 默认值:
true
# 文章作者信息
# author
文章默认的作者信息
- 类型:
string
|{name: String, link: String}
- 默认值:
undefined
name
: 作者名称link
: 作者链接
# 指定的文章作者信息
你也可以在指定的文章front matter
设置作者信息,优先级比默认作者信息高,示例:
---
author:
name: 作者名
link: https://xxx.com
---
或
---
author: 作者名
---
2
3
4
5
6
7
8
9
# 博主信息
# blogger
博主信息显示于首页博主信息栏
- 参数和类型:
{avatar: String, name: String, slogan: String}
- 默认值:
undefined
avatar
: 头像,必需name
: 博主名称,必需slogan
: 标语,可选
# 社交图标
# social
社交图标显示于博主信息栏和页脚栏
- 参数和类型:
{iconfontCssFile: String, icons: [{iconClass: String, title: String, link: String}]}
- 默认值:
undefined
iconfontCssFile
: 可选,阿里图标库(或其他)的在线css字体图标文件地址,对于主题没有的图标可自由添加icons
: 图标列表,数量自由iconClass
: 图标的Class名称title
: 图标的titlelink
: 图标的跳转链接
# 页脚版权栏
# footer
页脚版权栏信息,原默认主题在首页的front matter
中的footer
配置项已弃用
- 参数和类型:
{createYear: Number | String, copyrightInfo: String}
- 默认值:
undefined
createYear
博客创建的年份copyrightInfo
博客版权信息,支持a
标签
# 评论栏
# comment
是否启用评论栏
- 参数和类型:
boolean
- 默认值:
false
# 文档编辑
# editLinks
是否启用文档编辑
- 参数和类型:
boolean
- 默认值:
false
# editLinkText
编辑按钮显示的文本
- 参数和类型:
string
- 默认值:
编辑