Frontmatter 配置

信息 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[];

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

isOriginal

• 类型: boolean
• 必填: 否
• 默认值: false

当前文章是否为原创。

date

• 类型: DateString
• 必填: 否
• 默认值: ""

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

category

• 类型: string | string[]
• 必填: 否
• 默认值: ""

当前页面的分类。

tag

• 类型: string | string[]
• 必填: 否
• 默认值: ""

当前页面的标签。

license

• 类型: string
• 必填: 否
• 默认值: 主题选项中的值

当前页面的版权信息。

copyright

• 类型: string | false
• 必填: 否
• 默认值: 主题选项中的值

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

pageView

• 类型: boolean
• 必填: 否
• 默认值: true

是否显示当前页面的访问量。

article

• 类型: boolean
• 必填: 否
• 默认值: true

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

timeline

• 类型: boolean
• 必填: 否
• 默认值: true

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

sticky

• 类型: boolean | number
• 必填: 否
• 默认值: false

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

star

• 类型: boolean | number
• 必填: 否
• 默认值: false

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

cover

• 类型: string
• 必填: 否
• 默认值: ""

当前页面的封面图。

banner

• 类型: string
• 必填: 否
• 默认值: ""

当前页面的横幅图。