Skip to content

配置参考

本文档提供 Starlight 配置选项的参考。

网站标题,显示在导航栏和页面标题中。

title: '我的文档库'

网站描述,用于 SEO 和 meta 标签。

description: '这是我的个人文档库'

网站 Logo,可以是图片路径或包含 light/dark 变体的对象。

logo: {
src: './src/assets/logo.png',
}

社交链接数组,支持多种图标。

social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/yourusername' },
{ icon: 'twitter', label: 'Twitter', href: 'https://twitter.com/yourusername' },
]

侧边栏配置,支持手动定义和自动生成。

sidebar: [
{
label: '指南',
items: [
{ label: '快速开始', slug: 'guides/getting-started' },
],
},
{
label: '参考',
autogenerate: { directory: 'reference' },
},
]

自定义样式文件路径。

customCss: ['./src/styles/custom.css']