HomeLogo

@mr-hope/vuepress-plugin-git

Git 信息插件

这个插件将会利用 Git 向 page 注入页面的贡献者与创建时间、最后更新时间的时间戳,同时还会使用 dayjs 生成本地化的时间文字。

# 使用插件

# 安装

# 使用

// .vuepress/config.js
module.exports = {
  plugins: [
    [
      "@mr-hope/git",
      {
        // your options
      },
    ],
  ],
};
1
2
3
4
5
6
7
8
9
10
11

# 插件说明

该插件基于 Git,会自动读取文件的创建时间、上一次提交时间与贡献者,并注入到 page 上。同时,还会使用 dayjs 本地化时间,生成可阅读的时间文字。

interface GitContributor {
  /** 姓名 */
  name: string;
  /** 邮箱 */
  email: string;
  /** 贡献的提交数 */
  commits: number;
}

interface Page {
  // other keys...

  /** Git 贡献者 */
  contributors?: GitContributor[];
  /** 当前语言的创建时间文字 */
  createTime?: string;
  /** 创建时间的时间戳 */
  createTimeStamp?: number;
  /** 当前语言的更新时间文字 */
  updateTime?: string;
  /** 更新时间的时间戳 */
  updateTimeStamp?: number;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 配置

# contributor

  • 类型: boolean
  • 默认值: true

是否生成贡献者信息。

# timezone

  • 类型: string
  • 必填: 否

有些时候你的站点可能通过 CI 自动部署,而这些 CI 服务器的时间可能基于 UTC,这会导致生成的时间不同于你所在的时区,在这种情况下,你可以设置 timezone 选项 来指定你所在的时区。

时区列表

详细的时区列表,详见 时区列表 (opens new window)

# transformer

  • 类型: (timestamp: number, lang: string) => string
  • 默认值: `${dayjs(timestamp).format('LL')} ${dayjs(timestamp).format('HH:mm')}`

时间转换函数,默认情况下,会使用 dayjs 自动根据当前页面语言进行本地化。

如: 2020年5月8日 16:05 May 8, 2020 16:05