Blog Home Frontmatter Config
About 1 min
home
- Type:
true
- Details:
Must be true
to use blog home layout.
layout
- Type:
"BlogHome"
- Details:
Must be BlogHome
to use blog home layout.
title
- Type:
string
- Required: No
- Details:
Page title, will be used in breadcrumb, seo, etc.
heroText
- Type:
string
- Default: Site title
- Details:
Hero Title, can be set to an empty string to hide the default title.
tagline
- Type:
string
- Required: No
- Details:
Short description in hero
heroImage
- Type:
string
- Required: No
- Details:
Image link used as home hero (logo).
heroImageDark
- Type:
string
- Default:
heroImage
- Details:
Darkmode Home hero (logo) image link.
heroImageStyle
- Type:
Record<string, string> | string
- Required: No
- Details:
CSS style for home hero (logo) image
heroAlt
- Type:
string
- Required: No
- Details:
Home icon alt text
bgImage
- Type:
string | false
- Default: A built-in picture
- Details:
Link of background image, relative path is not supported.
bgImageDark
- Type:
string
- Default:
bgImage
- Details:
Link of darkmode background image, relative path is not supported.
bgImageStyle
- Type:
Record<string, string> | string
- Required: No
- Details:
The CSS style of the background image.
heroFullScreen
- Type:
boolean
- Default:
false
- Details:
Whether Hero is full screen displayed
projects
Type:
ThemeBlogHomeProjectOptions[]
interface ThemeBlogHomeProjectOptions { /** * Project name */ name: string; /** * Project description */ desc?: string; /** * Project link */ link: string; /** * Project icon * * @description image link or icon fontClass are supported, as well as `"link"`、`"project"`、`"book"`、`"article"`、`"friend"` */ icon?: string; }
Required: No
Details:
Project list displayed in blog homepage.