---
title: 页面配置
createTime: 2022/05/14 10:43:53
author: pengzhanbo
permalink: /note/vuepress-theme-plume/page-config/
---

## 说明

页面配置是为了能够以更细小的颗粒度控制单个页面的行为。

在本主题中，当你启动本地服务器后，主题会在你新建 `markdown`文件时，自动在文件头部插入基本的配置，你可以随时修改它。

`markdown`中的配置形式，如下所示：
``` md
---
title: 标题
createTime: 2022/04/09 01:24:17
author: You
permalink: /note/vuepress-theme-plume/page-config/
tags:
  - vuepress
---
```
配置内容是以 `YAML` 的格式进行书写的。

## 配置字段

### title

- 类型： `string`
- 默认值： `''`
- 详情：
  
  文章标题，启动本地服务器时，如果该字段为空，会根据当前文件名称自动生成。

### createTime

- 类型： `DateString` 格式 `yyyy/MM/dd hh:mm:ss`
- 默认值： `''`
- 详情：
  
  文章创建时间，启动本地服务器时，如果该字段为空，会根据当前文件的创建时间自动生成

### author

- 类型： `string`
- 默认值： `''`
- 详情：
  
  文章作者，启动本地服务器时，如果该字段为空，会根据当前项目`package.json`中的`author`字段生成

### permalink

- 类型： `string`
- 默认值： `''`
- 详情：
  
  文章永久链接，启动本地服务器时，如果该字段为空，会根据默认规则生成。

  在本主题中通过 `nanoid` 生成文章唯一链接。

### tags

- 类型: `string[]`
- 默认值： `[]`
- 详情：
  
  文章标签，可配置多个
- 示例：
  ``` md
  ---
  tags:
    - html
    - javascript
  ---
  ```
### sticky

- 类型： `boolean | number`
- 默认值： `false`
- 详情：
  
  是否置顶当前文章。

  当同时配置多篇文章置顶，如果值为number，则number越大的文章越靠前。

### article

- 类型： `boolean`
- 默认值: `true`， 在`notes` 中的文章，默认值为 `false`
- 详情：
  
  是否将文章收录到 首页 文章列表

## 首页配置字段

### home

- 类型： `boolean`
- 默认值： `true`
- 详情：
  
  标记当前 md文件为博客首页，仅在 `{sourceDir}/README.md` 中配置即可

### banner

- 类型： `string`
- 默认值： `''`
- 详情
  
  配置首页首屏大图


### mobileBanner

- 类型： `string`
- 默认值：`''`
- 详情
  
  配置首页首屏，在移动端设备中使用的大图
### motto

- 类型： `string`
- 默认值： `''`
- 详情
  
  座右铭，显示在首屏大图上

``` md
---
home: true
banner: /images/big-banner.jpg
motto: 世间的美好总是不期而遇，恬静而自然。
---
```
