主页

VitePress 默认主题提供了一个主页布局，您也可以在 本网站主页 上看到它。您可以在任何页面上使用它，方法是在 前置信息 中指定 layout: home。

---
layout: home
---

但是，仅此选项并不能做太多。您可以通过设置其他选项（如 hero 和 features）来向主页添加几个不同的预模板“部分”。

英雄部分

英雄部分位于主页顶部。以下是配置英雄部分的方法。

---
layout: home

hero:
  name: VitePress
  text: Vite & Vue powered static site generator.
  tagline: Lorem ipsum...
  image:
    src: /logo.png
    alt: VitePress
  actions:
    - theme: brand
      text: Get Started
      link: /guide/what-is-vitepress
    - theme: alt
      text: View on GitHub
      link: https://github.com/vuejs/vitepress
---

interface Hero {
  // The string shown top of `text`. Comes with brand color
  // and expected to be short, such as product name.
  name?: string

  // The main text for the hero section. This will be defined
  // as `h1` tag.
  text: string

  // Tagline displayed below `text`.
  tagline?: string

  // The image is displayed next to the text and tagline area.
  image?: ThemeableImage

  // Action buttons to display in home hero section.
  actions?: HeroAction[]
}

type ThemeableImage =
  | string
  | { src: string; alt?: string }
  | { light: string; dark: string; alt?: string }

interface HeroAction {
  // Color theme of the button. Defaults to `brand`.
  theme?: 'brand' | 'alt'

  // Label of the button.
  text: string

  // Destination link of the button.
  link: string

  // Link target attribute.
  target?: string

  // Link rel attribute.
  rel?: string
}

自定义名称颜色

VitePress 使用品牌颜色 (--vp-c-brand-1) 来表示 name。但是，您可以通过覆盖 --vp-home-hero-name-color 变量来自定义此颜色。

:root {
  --vp-home-hero-name-color: blue;
}

您还可以通过结合 --vp-home-hero-name-background 来进一步自定义它，以使 name 具有渐变色。

:root {
  --vp-home-hero-name-color: transparent;
  --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe, #41d1ff);
}

功能部分

在功能部分，您可以在英雄部分之后列出您想要显示的任何数量的功能。要配置它，请将 features 选项传递给前置信息。

您可以为每个功能提供一个图标，它可以是表情符号或任何类型的图像。当配置的图标是图像（svg、png、jpeg...）时，您必须以正确的宽度和高度提供图标；您也可以在需要时提供描述、其固有大小以及其深色和浅色主题的变体。

---
layout: home

features:
  - icon: 🛠️
    title: Simple and minimal, always
    details: Lorem ipsum...
  - icon:
      src: /cool-feature-icon.svg
    title: Another cool feature
    details: Lorem ipsum...
  - icon:
      dark: /dark-feature-icon.svg
      light: /light-feature-icon.svg
    title: Another cool feature
    details: Lorem ipsum...
---

interface Feature {
  // Show icon on each feature box.
  icon?: FeatureIcon

  // Title of the feature.
  title: string

  // Details of the feature.
  details: string

  // Link when clicked on feature component. The link can
  // be both internal or external.
  //
  // e.g. `guide/reference/default-theme-home-page` or `https://example.com`
  link?: string

  // Link text to be shown inside feature component. Best
  // used with `link` option.
  //
  // e.g. `Learn more`, `Visit page`, etc.
  linkText?: string

  // Link rel attribute for the `link` option.
  //
  // e.g. `external`
  rel?: string

  // Link target attribute for the `link` option.
  target?: string
}

type FeatureIcon =
  | string
  | { src: string; alt?: string; width?: string; height: string }
  | {
      light: string
      dark: string
      alt?: string
      width?: string
      height: string
    }

Markdown 内容

您只需在 --- 前置信息分隔符下方添加 Markdown，即可向网站主页添加更多内容。

---
layout: home

hero:
  name: VitePress
  text: Vite & Vue powered static site generator.
---

## Getting Started

You can get started using VitePress right away using `npx`!

```sh
npm init
npx vitepress init
```

信息

VitePress 并不总是自动设置 layout: home 页面的额外内容的样式。要恢复到旧的行为，您可以在前置信息中添加 markdownStyles: false。