# @citation-js/plugin-github 中文文档

规范地址：https://npmcn.com/package/%40citation-js/plugin-github/

版本：0\.7\.2
npm 元数据更新时间：2026-09-20T10:30:14.985Z
中文译文更新时间：2026-11-09T17:00:13.745Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40citation-js/plugin-github
原文对照：https://npmcn.com/package/%40citation-js/plugin-github/?lang=original
项目主页：https://github.com/citation-js/plugin-software-formats#readme
源码仓库：https://github.com/citation-js/plugin-software-formats

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.8 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：2 个
- 首次发布：2023-03-26T16:51:15.258Z
- 最新版本发布：2026-09-20T10:30:14.786Z
- 近 30 天下载量：28303（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 4 个）

## 中文简介

GitHub 仓库的引用. js 插件

## 安装

```sh
npm install @citation-js/plugin-github
```

也可以使用：`pnpm add @citation-js/plugin-github`、`yarn add @citation-js/plugin-github`、`bun add @citation-js/plugin-github`

## README

此插件可以从 GitHub API 获取书目数据 .

> GitHub API有利率限制. 未经批准的请求是每小时60个请求。 由于API是有限的,为单个寄存器检索书目数据可以接受~10 API请求. 根据授权请求,您可满足每小时5000个请求。 要让 Citation.js 发布授权请求, 您可以设置 OAuth 令牌 。 要从您的 GitHub 账户中获取 OAuth 令牌, 请查看 [本指南](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)。不需要选择任何额外的范围。 引用.js不会做任何事情 与OAuth的标志.

## 安装

### 无

```js
npm install @citation-js/plugin-github
```

### 浏览器

盖起一个 `@citation-js/plugin-github` 编辑 [构建工具](https://juniper-coat.glitch.me/)来啊!

## 使用

注册插件 `require`\- 说:

```js
require('@citation-js/plugin-github')
```

插件随后可用作如下:

```js
const { Cite, plugins } = require('@citation-js/core')

plugins.config.get('@github').setApiToken(OAUTH_TOKEN)

Cite.async('https://github.com/citation-js/plugin-software-formats')

{
  type: 'book',
  'title-short': 'plugin-software-formats',
  title: 'citation-js/plugin-software-formats',
  abstract: 'Collection of software-related input and output formats for Citation.js',
  URL: 'https://github.com/citation-js/plugin-software-formats',
  issued: { 'date-parts': [ [2020, 30, 21] ] },
  author: [ { given: 'Lars', family: 'Willighagen' } ],
  version: 'v0.4.2'
}
```

## 常见问题

### @citation-js/plugin-github 是什么？

GitHub 仓库的引用\. js 插件

### 如何安装 @citation-js/plugin-github？

在项目目录运行 npm install @citation-js/plugin-github，或使用 pnpm add / yarn add / bun add。

### @citation-js/plugin-github 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @citation-js/plugin-github 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @citation-js/plugin-github 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @citation-js/plugin-github 可以商用吗？

@citation-js/plugin-github 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @citation-js/plugin-github 的下载量有多少？

根据 npm 官方下载统计，@citation-js/plugin-github 在 2026/10/10 – 2026/11/08 这 30 天内被下载 28,303 次，日均约 943 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @citation-js/plugin-github 还在维护吗？

最新版本 0\.7\.2 发布于 2026/09/20（1 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 4 个；首次发布于 2023/03/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。