Home Page

To use it, specify page: true plus some other metadata in your root index.md's YAML frontmatter. This is an example of how it works:

---
page: true
heroImage: /logo.png
heroAlt: Logo image
heroText: VitePress-Theme-Vue
description: VitePress theme base on @vue/theme, more practical and comprehensive.
actionButtons:
  - text: Get Started
    link: /guide/getting-started
features:
  - title: Easy To Use
    details: Remove hard-coded, make it easy to use.
  - title: Home Page Support
    details: Use YAML frontmatter block in md file to custom home page.
  - title: Practical Components
    details: More practical components to help you write.
footer: MIT Licensed | Copyright © 2022-present Alex Wei | Powered by VitePress
---

<Home />

Tips

The global <Home /> component must be used in the md file of the home page.

Full list of slots available in the Home component:

home-hero
home-features
home-footer

Home Page #

Home Page