CommitChangelog

概述

根据指定文件路径，从 GitHub 仓库获取提交历史，以时间线形式展示。

前置要求

• GitHub 配置：在 app/app.config.ts 中配置 GitHub 相关信息。详见 GitHub 集成配置。
• 环境变量：在 .env 文件中配置 GitHub Token：

  NUXT_GITHUB_TOKEN=ghp_your_personal_access_token_here
  

用法

基本用法

在您的 Markdown 文档中使用以下语法：

:commit-changelog

组件会自动根据当前页面路由推断组件名称，并获取对应文件的提交历史。

显示 Vue 组件的提交历史

:commit-changelog{name="Accordion"}

输出示例：

• a1b2c — fix: 修复折叠动画延迟问题 #45
• d4e5f — feat: 添加 disabled 属性支持

显示 TypeScript 文件的提交历史

:commit-changelog{suffix="ts" name="useColorMode"}

按作者过滤提交

通过在 URL 查询参数中添加 author 可以只显示特定作者的提交：

:commit-changelog{author="user@example.com"}

使用 kebab-case 命名的文件

对于使用 kebab-case 命名的 composables 或 utils 文件：

:commit-changelog{suffix="ts" name="use-user" casing="kebab" commitPath="composables"}

这将查找 composables/use-user.ts 的提交历史。

export default defineAppConfig({
  github: {
    casing: 'kebab', // 全局默认使用 kebab-case
    // 其他配置...
  }
})

完整配置示例

::commit-changelog
---
commitPath: 'packages/core/src'
prefix: 'components'
suffix: 'ts'
name: 'useUser'
author: 'user@example.com'
---

API

Props

Changelog