CommitChangelog 根据文件路径请求 GitHub 提交记录,并按发布版本分组:已发布的提交归入对应版本,尚未发布的归入 Soon。站点有 版本发布页 时,版本标签链接到站内页面,否则跳转到 GitHub Release。
该组件不依赖 componentDocs 开关,开启 GitHub 集成即可使用。
前置条件
- 仓库信息:
github.owner、github.name、github.url与github.branch默认从本地 git remote 推断,推断失败时在app/app.config.ts中手动填写,见 app.config 参考 - 访问令牌:在环境变量中配置
NUXT_GITHUB_TOKEN
.env
NUXT_GITHUB_TOKEN=<your-github-token>
未配置令牌或设置了
github: false 时,组件显示 No recent changes,不会导致构建失败。用法
推导文件路径
:commit-changelog
文件路径按 {commitPath}/{prefix}/{name}.{suffix} 拼接:
| 片段 | 来源 |
|---|---|
commitPath | 组件的 commitPath,其次 github.commitPath,默认 src |
prefix | 组件的 prefix,默认为空 |
name | 组件的 name,默认取当前路由最后一段 |
suffix | 组件的 suffix,其次 github.suffix,默认 vue |
name 按 casing 转换:默认的 auto 对 .vue 文件使用 PascalCase,其他文件使用 camelCase;kebab、camel、pascal 强制使用对应格式。例如在 /docs/components/accordion 页面中,上面的写法对应 src/Accordion.vue。
指定文件
:commit-changelog{name="useUser" suffix="ts" commitPath="src/composables"}
文件统一使用 kebab-case 命名时,在 app/app.config.ts 中全局设置,省去每处单独指定:
app/app.config.ts
export default defineAppConfig({
github: {
commitPath: 'src/composables',
suffix: 'ts',
casing: 'kebab'
}
})
关联多个文件
files 中的每一项是对顶层字段(commitPath、prefix、suffix、name、casing)的局部覆盖,未写的字段沿用顶层值。各文件的提交合并去重后按时间倒序展示:
::commit-changelog
---
commitPath: layer/app/composables
suffix: ts
files:
- name: useHeader
- name: useNavigation
---
::
按作者过滤
author 传入 GitHub 用户名或提交邮箱:
:commit-changelog{author="octocat"}
获取范围受
github.since、github.until 与 github.perPage 控制,默认不限制日期,每个文件最多获取 100 条。AI 与 raw markdown
在 /raw/**.md 与 MCP 返回的 Markdown 中,组件被替换为指向 GitHub 提交历史的链接,路径推导规则相同;此时未指定 name 会使用页面标题。
API
Props
| Prop | Default | Type |
|---|---|---|
commitPath | 'src' | string仓库中的文件路径 |
prefix | string文件路径的前缀 | |
suffix | 'vue' | string文件扩展名 |
name | string要获取更新日志的组件或文件名 | |
author | string按作者筛选提交 | |
casing | 'auto' | "auto" | "kebab" | "camel" | "pascal"文件名的命名格式
|
files | CommitChangelogFile[]关联多个文件:每一项与顶层 props 合并后各自解析出一个文件路径, 对应的提交记录会合并去重并按时间倒序展示 |
相关
- PageLastCommit:在页头显示当前页面的最后一次提交
Changelog
No recent changes