---
title: 通用配置
author: pengzhanbo
createTime: 2024/03/02 20:01:09
permalink: /config/frontmatter/basic/
---

## 概述

通用 Frontmatter 配置，适用于 所有的文章。

示例：

```md
---
title: 标题
author: 作者
createTime: 2024/03/02 20:01:09
permalink: /config/frontmatter/basic/
---
```

## 配置

### title

文章标题。

主题会在文件创建时，自动填充 当前文件名作为 文章标题。

### author

文章作者。

主题会在文件创建时，自动填充 `avatar.name || packageJson.author` 作为 文章作者。

### createTime

文章创建时间。

主题会在文件创建时，自动填充 当前时间作为 文章创建时间。

### permalink

文章永久链接。

主题会在文件创建时:

- 博客类型的文章，自动填充 `/article/` + `nanoid 生成的 6 位随机字符串` 作为 文章永久链接
- notes 目录下的文章，会根据 notes 的配置，自动填充  文章永久链接

### externalLink

- 类型： `boolean`
- 默认值： `true`

当前文章内的 外部链接是否显示 外部链接图标。

### backToTop

- 类型： `boolean`
- 默认值： `true`

当前文章是否 显示 回到顶部 的按钮。

### comments

- 类型： `boolean`
- 默认值： `true`

当前文章是否 可评论。 仅在启用了评论功能的情况下生效。

### aside

- 类型： `boolean`
- 默认值： `true`

当前文章是否 显示 右侧边栏。

### outline

- 类型： `false | number | [number, number] | 'deep'`
- 默认值： `[2, 3]`
- 详情：

  要显示的标题级别。

  单个数字表示只显示该级别的标题。

  如果传递的是一个元组，第一个数字是最小级别，第二个数字是最大级别。

  `'deep'` 与 `[2, 6]` 相同，将显示从 `<h2>` 到 `<h6>` 的所有标题。

### prev

- 类型： `string | { text: string, link: string, icon?: string }`
- 默认值： `''`

自定义当前文章的上一篇文章。

- 博客类型的文章，主题根据时间排序，自动填充上一篇文章的标题和链接。
- notes 类型的文章，主题根据 note sidebar 配置，自动填充上一篇文章的标题和链接。

### next

- 类型： `string | { text: string, link: string, icon?: string }`
- 默认值： `''`

自定义当前文章的下一篇文章。

- 博客类型的文章，主题根据时间排序，自动填充下一篇文章的标题和链接。
- notes 类型的文章，主题根据 note sidebar 配置，自动填充下一篇文章的标题和链接。

### readingTime

- 类型： `boolean`
- 默认值： `true`

当前文章是否 显示 阅读时长。

### lastUpdated

- 类型： `boolean`
- 默认值： `true`

当前文章是否 显示 最后更新时间。 最后更新时间 根据 git 提交时间自动填充。

### contributors

- 类型： `boolean`
- 默认值： `true`

当前文章是否 显示 贡献者。 贡献者 根据 git 提交者自动填充。

### editLink

- 类型： `boolean`
- 默认值： `true`

当前文章是否 显示 文章编辑 按钮。

### watermark

- 类型： `boolean | WatermarkConfig`
- 默认值： `undefined` 主题不启用水印，或不启用全局水印时，默认值为 `false`，启用全局水印则为 `true`。

配置当前文章 水印。

```ts
interface WatermarkConfig {
  content?: string // 水印文字内容，可传入 html 内容
  textColor?: string // 水印文本颜色
  image?: string // 水印图片路径，优先于 content
  opacity?: number // 水印透明度
  rotate?: number // 水印旋转角度
  width?: number //  水印宽度
  height?: number // 水印高度
  gapX?: number // 水印横向间距
  gapY?: number // 水印纵向间距
  fullPage?: boolean // 是否全屏
  onlyPrint?: boolean // 是否仅在打印时显示
}
```