Blog Home Frontmatter Config

home

• Type: true
• Details:
  • Blog → Blog HomePage

Must be true to use blog home layout.

layout

• Type: "Blog"
• Details:
  • Blog → Blog HomePage

Must be Blog to use blog home layout.

title

• Type: string
• Required: No
• Details:
  • Blog → Blog HomePage

Page title, will be used in breadcrumb, seo, etc.

heroText

• Type: string
• Default: Site title
• Details:
  • Blog → Blog HomePage

Hero Title, can be set to an empty string to hide the default title.

tagline

• Type: string
• Required: No
• Details:
  • Blog → Blog HomePage

Short description in hero

heroImage

• Type: string
• Required: No
• Details:
  • Blog → Blog HomePage
  • FAQ → Links in Config

Image link used as home hero (logo).

heroImageDark

• Type: string
• Default: heroImage
• Details:
  • Blog → Blog HomePage
  • FAQ → Links in Config

Dark mode Home hero (logo) image link.

heroImageStyle

• Type: Record<string, string> | string
• Required: No
• Details:
  • Blog → Blog HomePage

CSS style for home hero (logo) image

heroAlt

• Type: string
• Required: No
• Details:
  • Blog → Blog HomePage

Home icon alt text

bgImage

• Type: string | false
• Default: A built-in picture
• Details:
  • Blog → Blog HomePage
  • FAQ → Links in Config

Link of background image, relative path is not supported.

bgImageDark

• Type: string
• Default: bgImage
• Details:
  • Blog → Blog HomePage
  • FAQ → Links in Config

Link of dark mode background image, relative path is not supported.

bgImageStyle

• Type: Record<string, string> | string
• Required: No
• Details:
  • Blog → Blog HomePage

The CSS style of the background image.

heroFullScreen

• Type: boolean
• Default: false
• Details:
  • Blog → Blog HomePage

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:

  • Blog → Blog HomePage

Project list displayed in blog homepage.