mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
24 lines
850 B
24 lines
850 B
4 years ago
|
# Theme Config: Homepage
|
||
|
|
|
||
|
|
VitePress provides a homepage layout. To use it, specify `home: true` plus some other metadata in your root `index.md`'s [YAML frontmatter](../guide/frontmatter). This is an example of how it works:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
---
|
||
|
|
home: true
|
||
|
|
heroImage: /logo.png
|
||
|
|
heroAlt: Logo image
|
||
|
|
heroText: Hero Title
|
||
|
|
tagline: Hero subtitle
|
||
|
|
actionText: Get Started
|
||
|
|
actionLink: /guide/
|
||
|
|
features:
|
||
|
|
- title: Simplicity First
|
||
|
|
details: Minimal setup with markdown-centered project structure helps you focus on writing.
|
||
|
|
- title: Vue-Powered
|
||
|
|
details: Enjoy the dev experience of Vue + webpack, use Vue components in markdown, and develop custom themes with Vue.
|
||
|
|
- title: Performant
|
||
|
|
details: VitePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
|
||
|
|
footer: MIT Licensed | Copyright © 2019-present Evan You
|
||
|
|
---
|
||
|
|
```
|