信息 Frontmatter 配置

大约 2 分钟

你可以在页面的 frontmatter 配置以下选项设置页面相关信息。

title

类型: string
必填: 否

当前页面内容标题，默认为 Markdown 文件中的第一个 h1 标签内容。

shortTitle

类型: string
必填: 否

当前页面的短标题，会在导航栏、侧边栏和路径导航中作为首选。

description

类型: string
必填: 否

当前页面内容描述。

icon

类型: string
必填: 否
详情:
- 界面 → 图标支持

当前页面图标的 FontClass 或文件路径 (建议填写)。

author

类型: Author | boolean

type AuthorName = string;

interface AuthorInfo {
  /**
   * 作者姓名
   */
  name: string;

  /**
   * 作者网站
   */
  url?: string;

  /**
   * 作者 Email
   */
  email?: string;
}

type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[];

必填: 否
详情:
- 功能 → 页面信息

作者，如果不填，则会回退到默认作者。

提示

在主题选项中指定默认作者时，可以设置 false 以防止显示默认作者。

isOriginal

类型: boolean
默认值: false
详情:
- 功能 → 页面信息

当前文章是否为原创。

date

类型: DateString
必填: 否
详情:
- 功能 → 页面信息

写作时间，格式: YYYY-MM-DD 或 YYYY-MM-DD hh:mm:ss

license

类型: string
默认值: 主题选项中的值
详情:
- 布局 → 页脚

页面的协议名称。

copyright

类型: string | false
默认值: 主题选项中的值
详情:
- 布局 → 页脚

页面的版权信息，会在页脚中显示。

pageview

类型: boolean
默认值: 主题选项中的值
详情:
- 功能 → 评论

是否显示浏览量。

提示

显示浏览量功能需要你拥有有效的 Waline 评论服务配置。

article

类型: boolean
默认值: true
详情:
- 博客 → 文章

是否将该文章添加至文章列表中。

timeline

类型: boolean
默认值: true
详情:
- 博客 → 时间线

是否将该文章添加至时间线中。

sticky

类型: boolean | number
默认值: false
详情:
- 博客 → 文章

是否在列表中置顶。当填入数字时，数字越大，排名越靠前。

star

类型: boolean | number
默认值: false
详情:
- 博客 → 文章

是否标为星标文章。当填入数字时，数字越大，排名越靠前。

cover

类型: string
必填: 否
详情:
- 常见问题 → 配置中的链接

页面的预览图。

类型: string
必填: 否
详情:
- 常见问题 → 配置中的链接

页面的宽屏分享图。