项目主页 Frontmatter 配置

选项

home必填boolean

是否使用项目首页布局。

titlestring

页面标题，会用于路径导航、SEO 等。

heroTextstring

默认值 站点标题

主页标题。设置为空字符串可隐藏默认标题。

taglinestring

默认值"Welcome to your VuePress site"

主页的简短描述。

heroImagestring

主页图标 (logo) 链接，不支持相对路径。

heroImageDarkstring

默认值heroImage

深色模式下主页图标 (logo) 链接，不支持相对路径。

heroAltstring

默认值heroText

主页图标的替代文字。

heroImageStyleRecord<string, string> | string

首页图标的 CSS 样式。

bgImagestring

背景图片的地址，不支持相对路径。

bgImageDarkstring

默认值bgImage

深色模式下背景图片的地址，不支持相对路径。

bgImageStyleRecord<string, string> | string

背景图片的 CSS 样式。

heroStylestring

Hero 样式。

heroFullScreenboolean

是否全屏显示 Hero。

actionsThemeProjectHomeActionOptions[]

主页操作。

actions[*].text必填string

操作名称。

actions[*].link必填string

操作链接。

actions[*].type'primary' | 'default'

默认值'default'

操作类型。

actions[*].iconstring

操作图标。

highlights(ThemeProjectHomeFeatureOptions | ThemeProjectHomeHighlightOptions)[]

主页的亮点区域。每一项要么是功能区域，要么是亮点区域。

highlights[*].headerstring

区域标题，支持 HTML 字符串。亮点区域中为必填。

highlights[*].descriptionstring

区域描述，支持 HTML 字符串。

highlights[*].colorstring

文字颜色。

highlights[*].imagestring

区域图像。

highlights[*].imageDarkstring

默认值image

夜间模式使用的区域图片。

highlights[*].bgImagestring

区域背景图。

highlights[*].bgImageDarkstring

默认值bgImage

夜间模式使用的区域背景图。

highlights[*].bgImageStyleRecord<string, string> | string

区域背景图样式。

highlights[*].featuresfeature-section: YesThemeProjectHomeFeatureItem[]

功能区域中的功能。

highlights[*].features[*].title必填string

项目名称，支持 HTML 字符串。

highlights[*].features[*].detailsstring

项目描述，支持 HTML 字符串。

highlights[*].features[*].iconstring

项目图标，支持图片链接或图标字体类。

highlights[*].features[*].linkstring

项目链接。

highlights[*].typehighlight-section: Yes'order' | 'un-order' | 'no-order'

默认值'un-order'

亮点区域的列表类型。

highlights[*].highlightshighlight-section: YesThemeProjectHomeHighlightItem[]

亮点区域中的亮点。

highlights[*].highlights[*].title必填string

项目名称，支持 HTML 字符串。

highlights[*].highlights[*].detailsstring

项目描述，支持 HTML 字符串。

highlights[*].highlights[*].iconstring

项目图标，支持图片链接或图标字体类。

highlights[*].highlights[*].linkstring

项目链接。

featuresThemeProjectHomeFeatureItem[]

主页的功能。

features[*].title必填string

功能名称，支持 HTML 字符串。

features[*].detailsstring

功能描述，支持 HTML 字符串。

features[*].iconstring

功能图标，支持图片链接或图标字体类。

features[*].linkstring

功能链接。