进行站点配置与主题配置
使用 VitePress 时,你可以对站点、主题进行配置,文档参见:Site Config。
此部分我们尽量简略,因为你可以参考 VitePress 完备的文档来进行配置。
配置文件是 ./vitepress/config.mts
站点配置
1. 修改网站名称与描述
我们可以修改配置文件中的 title
和 description
。
ts
import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "My Awesome Project",
description: "A VitePress Site",
})
2. 显示设置:夜间模式
VitePress 缺省支持夜间模式,我们可以用如下设置将之关闭:
ts
...
export default defineConfig({
appearance: false
})
主题配置
我们可以配置缺省主题,参考文档:默认主题配置
ts
export default {
themeConfig: {
...
}
}
1. 整体配置
如果我们想配置一个中文网站的主题,可参考 VitePress 文档网站中中文版的相关配置: https://github.com/vuejs/vitepress/blob/main/docs/.vitepress/config/zh.ts
摘录部分如下:
ts
export const zh = defineConfig({
lang: 'zh-Hans',
description: '由 Vite 和 Vue 驱动的静态站点生成器',
themeConfig: {
nav: nav(),
sidebar: {
'/zh/guide/': { base: '/zh/guide/', items: sidebarGuide() },
'/zh/reference/': { base: '/zh/reference/', items: sidebarReference() }
},
editLink: {
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
text: '在 GitHub 上编辑此页面'
},
footer: {
message: '基于 MIT 许可发布',
copyright: `版权所有 © 2019-${new Date().getFullYear()} 尤雨溪`
},
docFooter: {
prev: '上一页',
next: '下一页'
},
outline: {
label: '页面导航'
},
lastUpdated: {
text: '最后更新于',
formatOptions: {
dateStyle: 'short',
timeStyle: 'medium'
}
},
langMenuLabel: '多语言',
returnToTopLabel: '回到顶部',
sidebarMenuLabel: '菜单',
darkModeSwitchLabel: '主题',
lightModeSwitchTitle: '切换到浅色模式',
darkModeSwitchTitle: '切换到深色模式'
}
})
2. 导航栏中的网站 logo
我们已经放入 logo 文件 ./docs/public/my-logo.svg
,然后可如下配置,Logo 将出现导航栏网站名称之前。
ts
export default {
themeConfig: {
logo: '/my-logo.svg'
}
}
3. 导航栏中的链接
可参考如下方式配置 nav
:
ts
export default {
themeConfig: {
nav: [
{ text: 'Guide', link: '/guide' },
{ text: 'Config', link: '/config' },
{ text: 'Changelog', link: 'https://github.com/...' }
]
}
}