Homepage

VT's homepage frontmatter (opens new window) configuration supports all options from VuePress's default theme (opens new window), at the same time, VT introduce extra features:

1. Additional options: subActionText, subActionLink, sponsors.
2. Configure rich-text heroText, tagline, and footer via Markdown Slot (opens new window).

Quick Start

1. Create docs/index.md, and declare home: true with Frontmatter (opens new window):

---
home: true
---

2. Declare hero image and hero text:

---
heroImage: /logo.svg
heroText: A Elegant VuePress Theme
---

If you want to use markdown syntax to define heroText, you can use Markdown Slot (opens new window):

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

::: slot heroText
An <b class="gradient">Elegant</b> VuePress Theme
:::

3. Declare action buttons:

---
actionText: Getting Started
actionLink: /guide/
subActionText: Install
subActionLink: /guide/
---

4. Declare main features:

---
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.
---

Example

The source code for the Home page you are now seeing is as follows:

---
home: true
actionText: Getting Started
actionLink: /guide/
subActionText: Install
subActionLink: /guide/getting-started.html
features:
  - title: Compatibility
    details: API familiar for VuePress old users, migrating from default theme is almost no costing.
  - 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.
  - title: TypeScript
    details: It's easier to custom your own config with full TypeScript support.
  - title: Homepage
    details: It's easier to have a homepage like as you can see.
  - title: API Page
    details: Generate an API page like this site's API page, which is very useful to index APIs.

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

::: slot heroText
An <b class="gradient">Elegant</b> VuePress Theme
:::

::: slot tagline
A VuePress 1.x theme inspired by `@vue/theme`, fully compatible with VuePress default theme.
:::

::: slot footer
Released under the MIT License.<br>
Copyright © 2022 ULIVZ
:::