@docmd/plugin-git 插件为您的文档网站添加仓库智能。它在编译期间直接查询本地 Git 历史，以展示页面修改时间戳、作者贡献以及自动化的“编辑此页面”链接。

配置选项

在 docmd.config.json 中配置仓库参数：

配置示例

{
  "plugins": {
    "git": {
      "repo": "https://github.com/docmd-io/docmd",
      "branch": "main",
      "editLink": true,
      "lastUpdated": true,
      "commitHistory": true,
      "maxCommits": 5
    }
  }
}

核心能力

• 最近更新时间戳: 为每个文件自动计算并显示在页面页脚中。
• 提交历史提示框: 鼠标悬停在时间戳上时渲染最近的 Commit Hash、提交信息和作者头像。
• 自动化编辑链接: 生成直接指向 GitHub、GitLab 或 Bitbucket 的编辑 URL。
• 构建期缓存: Git 查询在编译期间执行并自动在本地缓存结果，确保零运行时开销。

页面级控制

使用 页面 Frontmatter 为特定文档禁用 Git 功能：

---
title: "内部说明"
plugins:
  git: false
---

CI/CD 流水线集成

Git 插件在站点编译期间执行本地 git CLI 命令。许多 CI/CD 执行器（例如 GitHub Actions 或 GitLab CI）执行浅克隆（fetch-depth: 1），这会导致提交历史被截断，使所有页面显示完全相同的时间戳日期。

请确保您的构建工作流拉取完整的 Git 历史：

- name: Checkout Repository
  uses: actions/checkout@v4
  with:
    fetch-depth: 0

variables:
  GIT_DEPTH: 0

本地化支持

Git 插件支持用于页脚字符串和时间戳格式的多语言翻译映射。可通过 UI 本地化 配置提供自定义字符串。