Config: Home

The following are all the frontmatter configurations for the homepage.

heroImage

• Type: string
• Default: undefined

TIP

In VT, for the style of the homepage, we do not recommend that you use this config, and this config is kept only for compatibility with VuePress's Default Theme Config (opens new window),

Config hero image.

---
heroImage: /logo.svg
---

actionText

• Type: string
• Default: undefined

Main action button's text

---
actionText: Getting Started
---

actionLink

• Type: string
• Default: undefined

Main action button's link

---
actionLink: /guide/
---

subActionText

• Type: string
• Default: undefined

Sub action button's text

---
subActionText: Install
---

subActionLink

• Type: string
• Default: undefined

Sub action button's text

---
subActionLink: /guide/getting-started.html
---

features

• Type: array
• Default: undefined

Features configurations, it's better to set three or six items:

---
features:
  - title: Full-text search
    details: Full-text search is supported by default, no server dependency, distinguishing locales.
  - title: Out of the box
    details: Compatible with VuePress' default theme, built-in common documentation features, e.g. i18n, Code Copy, TOC.
  - title: TypeScript
    details: It's easier to custom your own config with full TypeScript support.
---

sponsors

• Type: array
• Default: undefined

---
sponsors:
  - title: n8n.io
    img: https://avatars.githubusercontent.com/u/45487711?s=200&v=4
    link: https://n8n.io/
---

sponsorsText

• Type: array
• Default: 'Special Sponsor'

Sponsor's intro text.