Skip to content

最后更新时间

你可以通过 config.lastUpdated 选项显示页面的最后更新时间。

js
export default {
  lastUpdated: true
}

启用后,每个页面的最后更新时间将通过 Git 显示在页面底部。

自定义文本

你可以使用 themeConfig.lastUpdated 选项自定义最后更新标签的文本:

js
export default {
  themeConfig: {
    lastUpdated: {
      text: 'Updated at',
      formatOptions: {
        dateStyle: 'full',
        timeStyle: 'medium'
      }
    }
  }
}

格式选项

你可以使用 formatOptions 来自定义日期格式。这些选项将传递给 Date.toLocaleString()

js
export default {
  themeConfig: {
    lastUpdated: {
      text: 'Updated at',
      formatOptions: {
        dateStyle: 'short',
        timeStyle: 'short'
      }
    }
  }
}

Frontmatter 配置

可以使用 frontmatter 上的 lastUpdated 选项在每个页面上禁用此功能:

yaml
---
lastUpdated: false
---

请注意,如果指定了日期,它将显示而不是从 Git 历史记录中推断的最后修改时间:

yaml
---
lastUpdated: 2024-01-01
---

类型定义

ts
export interface LastUpdatedOptions {
  /**
   * @default 'Last updated'
   */
  text?: string

  /**
   * @default
   * { dateStyle: 'short', timeStyle: 'short' }
   */
  formatOptions?: Intl.DateTimeFormatOptions & { forceLocale?: boolean }
}

vitepress开发指南