Project Home Frontmatter Config

Options

homeRequiredboolean

Whether to use the project home layout.

titlestring

Page title, used in breadcrumb, SEO, etc.

heroTextstring

Default The site title

Hero title. Set it to an empty string to hide the default title.

taglinestring

Default"Welcome to your VuePress site"

Short description in the hero.

heroImagestring

Home hero (logo) image link. Relative paths are not supported.

heroImageDarkstring

DefaultheroImage

Dark mode home hero (logo) image link. Relative paths are not supported.

heroAltstring

DefaultheroText

Alt text of the home icon.

heroImageStyleRecord<string, string> | string

CSS style for the home icon.

bgImagestring

Link of the background image. Relative paths are not supported.

bgImageDarkstring

DefaultbgImage

Link of the dark mode background image. Relative paths are not supported.

bgImageStyleRecord<string, string> | string

CSS style of the background image.

heroStylestring

Hero wrapper style.

heroFullScreenboolean

Whether the hero is displayed full screen.

actionsThemeProjectHomeActionOptions[]

Home actions.

actions[*].textRequiredstring

Action name.

actions[*].linkRequiredstring

Action link.

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

Default'default'

Type of the action.

actions[*].iconstring

Action icon.

highlights(ThemeProjectHomeFeatureOptions | ThemeProjectHomeHighlightOptions)[]

Highlight sections of the home page. Each item is either a feature section or a highlight section.

highlights[*].headerstring

Section header, which supports HTML strings. It is required for a highlight section.

highlights[*].descriptionstring

Section description, which supports HTML strings.

highlights[*].colorstring

Text color.

highlights[*].imagestring

Section image.

highlights[*].imageDarkstring

Defaultimage

Section image used in dark mode.

highlights[*].bgImagestring

Section background image.

highlights[*].bgImageDarkstring

DefaultbgImage

Section background image used in dark mode.

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

Section background image style.

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

Features of a feature section.

highlights[*].features[*].titleRequiredstring

Item name, which supports HTML strings.

highlights[*].features[*].detailsstring

Item description, which supports HTML strings.

highlights[*].features[*].iconstring

Item icon. Image links and icon font classes are supported.

highlights[*].features[*].linkstring

Item link.

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

Default'un-order'

List type of a highlight section.

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

Highlights of a highlight section.

highlights[*].highlights[*].titleRequiredstring

Item name, which supports HTML strings.

highlights[*].highlights[*].detailsstring

Item description, which supports HTML strings.

highlights[*].highlights[*].iconstring

Item icon. Image links and icon font classes are supported.

highlights[*].highlights[*].linkstring

Item link.

featuresThemeProjectHomeFeatureItem[]

Features of the home page.

features[*].titleRequiredstring

Feature name, which supports HTML strings.

features[*].detailsstring

Feature description, which supports HTML strings.

features[*].iconstring

Feature icon. Image links and icon font classes are supported.

features[*].linkstring

Feature link.