themeConfig参数说明
ts
// config.mts
export default defineConfigWithTheme<ThemeConfig>({
// ...
themeConfig: {
// ...
}
})author
- 类型：
string - 要求：可选
- 作者名称
docCount
- 类型：
number - 要求：可选
- 默认值：10
- 博客首页文章列表的每页展示文章数量
startYear
- 类型：
number - 要求：可选
- 博客起始时间
headImage
- 类型：
string - 要求：可选
- 头图url
headStyle
- 类型：
object - 要求：可选
- 头图样式
authorImage
- 类型：
string - 要求：可选
- 作者头像url
umami
- 要求：可选
- 站点统计
umamiToken
- 类型：
string - 要求：必选
- umamiToken,用于站点统计
umamiUrl
- 类型：
string - 要求：必选
- umamiApi地址，用于站点统计，在开发环境下不启用，需要使用代理
umamiId
- 类型：
string - 要求：必选
- umami被统计网站的id
comment
- 要求：可选
- 评论配置
repo
- 类型：
string - 要求：必选
- 仓库地址，用于评论
repoId
- 类型：
string - 要求：必选
- 仓库Id,用于评论
categoryId
- 类型：
string - 要求：必选
- 分类id,用于评论
reactionsEnabled
- 类型：
0 | 1 - 要求：必选
- 默认值：
1 - 启用主帖子上的反应
fall
- 要求：可选
- 在屏幕上渲染一些装饰效果
image
- 类型：
month | BuiltinImageName | string - 要求：必选
- 渲染的图片。如果使用
month，将根据月份自动选择@night-tea/sakura-fall内置的 12 张水彩素材。 - 也可以指定内置素材名，或传入自定义图片 URL。
count
- 类型：
number - 要求：可选
- 默认值：
15 - 渲染数量
iconTags
- 类型：
boolean - 要求：可选
- 默认值：
false - 采用
shields.io图片作为标签风格 - 参考网址1
- 参考网址2
- iconTagStyle
- 类型：
object - 要求：可选
- 默认值：
{height:20px} - 标签样式
blogList
- 要求：可选
- 博客列表设置,一旦设置会给列表设置背景图片
- 后续会增加自定义图片设置
imagesSize
- 类型：
small | medium | large - 要求：可选
- 默认值：
medium - 背景图片大小
imagesLocation
- 类型：
left | right | center | reversal （左右交替） | leftRight （左右） - 要求：可选
- 默认值：
center - 背景图片位置
homeGarden
- 要求：可选
- 博客首页花园式头图区配置，用于控制头图区标识、推荐分类和快捷入口；不配置时会读取站点已有分类与导航作为兜底。
brandInitial
- 类型：
string - 要求：可选
- 默认值：
author的首字符；如果没有设置author，默认显示站 - 首页头图区左上角标识文案，适合放站点名首字、缩写或自定义符号。
featuredCategories
- 类型：
string[] - 要求：可选
- 首页头图区优先展示的分类名称。主题会按配置顺序读取实际存在的分类，并用站点内其他分类补足到最多 4 个。
ts
themeConfig: {
homeGarden: {
featuredCategories: ["Web", "Life", "Notes"],
},
}featuredLinks
- 类型：
{ title: string; desc?: string; link: string }[] - 要求：可选
- 首页头图区快捷入口。
link支持站内路径和外部链接；不配置时会从nav中取前 3 个站内导航作为兜底。
ts
themeConfig: {
homeGarden: {
featuredLinks: [
{ title: "文档", desc: "组件和主题说明", link: "/docs" },
{ title: "归档", desc: "按时间浏览内容", link: "/timeline" },
],
},
}treeHoleFooter
- 要求：可选
- 页脚配置。主题包不再内置个人项目链接，需要由站点自行配置。
themeLink
- 类型：
{ text: string; link: string } - 要求：可选
- 页脚左侧主题/项目链接。不配置时不显示该按钮。
ts
themeConfig: {
treeHoleFooter: {
themeLink: {
text: "vitepress-tree-hole",
link: "https://github.com/example/vitepress-tree-hole",
},
},
}memo
- 要求：可选
- 碎片笔记
memoUrl
- 类型：
string - 要求：必选
- 碎片笔记的接口地址
memoUser
- 类型：
string - 要求：必选
- 笔记的用户名称
memoToken
- 类型：
string - 要求：必选
- 接口token
route
页面内路由跳转
category
- 类型：
string - 要求：可选
- 默认值：
category - 分类跳转的页面(md),只需要名称，不需要文件后缀
tag
- 类型：
string - 要求：可选
- 默认值：
tag - 标签跳转的页面(md),只需要名称，不需要文件后缀
filter
- 类型：
string - 要求：可选
- 默认值：
filter - 分类和标签跳转的页面(md),只需要名称，不需要文件后缀