PageLastCommit 已挂载在每个文档页导语下方的元信息行,与「查看源码 / 复制页面」并列,无需在 Markdown 中手动添加。它显示:
- 更新时间:文件最后一次提交的时间,按
github.dateFormat格式化 - 作者:提交者的 GitHub 用户名与头像,链接到其主页
- 提交信息:提交标题的第一行,链接到该提交
启用条件
与 CommitChangelog 相同,需要 GitHub 集成可用并配置 NUXT_GITHUB_TOKEN:
.env
NUXT_GITHUB_TOKEN=<your-github-token>
文件路径按 {github.rootDir}/content/{页面路径} 拼接。文档站不在仓库根目录时设置 rootDir:
app/app.config.ts
export default defineAppConfig({
github: {
rootDir: 'docs'
}
})
rootDir 填写错误时请求不到提交记录,组件不渲染任何内容。设置 github: false 可整体关闭 GitHub 集成。日期格式
github.dateFormat.locale 与 github.dateFormat.options 传给 Intl.DateTimeFormat。layer 默认使用 zh-CN 与「年 / 月 / 日 时:分」,时区跟随服务端:
app/app.config.ts
export default defineAppConfig({
github: {
dateFormat: {
locale: 'en-US',
options: {
dateStyle: 'medium',
timeStyle: 'short',
timeZone: 'Asia/Shanghai'
}
}
}
})
日期在服务端格式化。预渲染部署时显示的是构建机所在时区,需要固定时区请显式设置
timeZone。options | 输出示例(zh-CN) |
|---|---|
{ year: 'numeric', month: 'numeric', day: 'numeric' } | 2026/10/23 |
{ year: 'numeric', month: 'short', day: 'numeric' } | 2026年10月23日 |
{ dateStyle: 'medium', timeStyle: 'short' } | 2026年10月23日 14:37 |
PR squash merge
通过 GitHub 网页合并 PR 时,提交者是 web-flow。组件检测到这种情况后,从提交信息中解析 PR 编号(如 #123),改为显示 PR 作者,并链接到该 PR。
自定义
组件的 props 由文档页自动传入,showAvatar、showMessage 无法在 Markdown 中设置。需要隐藏头像、提交信息或调整样式时,可在项目中创建同名组件覆盖;PageLastCommit 不在 覆盖契约 内,升级时需对照新实现检查。
API
Props
| Prop | Default | Type |
|---|---|---|
stem | '' | string文件路径(不含扩展名),通常由页面自动传入 |
extension | 'md' | string文件扩展名,通常由页面自动传入 |
showMessage | true | boolean 是否显示提交信息。 |
showAvatar | true | boolean 是否显示作者头像。 |
相关
- CommitChangelog:展示组件或源文件的完整提交时间线
Changelog
No recent changes