mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
60 lines
1015 B
Markdown
60 lines
1015 B
Markdown
---
|
|
title: 首页
|
|
author: pengzhanbo
|
|
createTime: 2024/03/03 15:00:43
|
|
permalink: /config/frontmatter/home/
|
|
---
|
|
|
|
## 概述
|
|
|
|
仅适用于 首页。在 `{sourceDir}/README.md` 中进行配置。
|
|
|
|
示例：
|
|
|
|
```md
|
|
---
|
|
home: true
|
|
config:
|
|
- type: banner
|
|
- type: custom
|
|
---
|
|
```
|
|
|
|
## 配置
|
|
|
|
### home
|
|
|
|
- 类型： `boolean`
|
|
|
|
声明是否为 首页
|
|
|
|
### config
|
|
|
|
- 类型： `PlumeHomeConfig[]`
|
|
|
|
定义 首页 区域
|
|
|
|
```ts
|
|
interface PlumeHomeConfigBase {
|
|
/**
|
|
* 该区域的类型，根据类型应用不同的组件
|
|
*/
|
|
type: 'banner' | 'hero' | 'text-image' | 'image-text' | 'features' | 'profile' | 'custom' | string
|
|
/**
|
|
* 该区域是否占满全屏
|
|
*/
|
|
full?: boolean
|
|
/**
|
|
* 该区域的背景图片
|
|
* 你可以定义在 浅色/暗色 模式下的背景图片
|
|
*/
|
|
backgroundImage?: string | { light: string, dark: string }
|
|
/**
|
|
* 该区域的背景 定位方式
|
|
*/
|
|
backgroundAttachment?: 'fixed' | 'local'
|
|
}
|
|
```
|
|
|
|
更多详细配置请参考 [自定义首页](/guide/custom-home/)
|