# 说明

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

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

markdown中的配置形式，如下所示：

---
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[]

• 默认值： []

• 详情：

  文章标签，可配置多个

• 示例：

  ---
  tags:
    - html
    - javascript
  ---
  

# sticky

• 类型： boolean | number

• 默认值： false

• 详情：

  是否置顶当前文章。

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

# article

• 类型： boolean

• 默认值: true， 在notes 中的文章，默认值为 false

• 详情：

  是否将文章收录到 博客 文章列表

# 首页配置字段

# home

• 类型： boolean

• 默认值： true

• 详情：

  标记当前 md文件为博客首页，仅在 {sourceDir}/README.md 中配置即可

# banner

• 类型： string

• 默认值： ''

• 详情

  配置首页首屏大图

# bannerMask

• 类型：number | { light?: number; dark?: number }

• 默认值： 0

• 详情

  取值范围： 0 - 1。配置首页 banner 大图的遮罩蒙版不透明度。支持配置 浅色/深色 模式下 的不同值。当值为 0 时，不显示遮罩蒙版。

  这在首页首屏大图比较亮时，可以适当使图片看起来暗一些。

  配置首页首屏，在移动端设备中使用的大图

# hero

• 类型： Hero

• 默认值： {}

• 详情

  首页大屏显示文案，用于展示网站高亮信息。

interface Hero {
  name: string
  tagline?: string
  text?: string
  actions: HeroAction[]
}

export interface HeroAction {
  theme?: 'brand' | 'alt'
  text: string
  link?: string
}

# 示例

---
home: true
banner: /images/home-banner.jpg
hero: 
  name: YanYun
  tagline: A Developer
  text: 以梦为马，不负韶华
  actions: 
    - 
      text: 我的博客
      link: /blog/
      theme: brand
    - 
      text: Github
      link: https://github.com/pengzhanbo
      theme: alt
---