@citation-js/plugin-github

中文文档
0.7.2发布于 2026/09/20MITTypeScriptES Module近 30 天下载 2.8万

GitHub 仓库的引用. js 插件

中文使用文档
文档目录4 节
  1. 安装
  2. 无
  3. 浏览器
  4. 使用

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

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

安装

无

npm install @citation-js/plugin-github

浏览器

盖起一个 @citation-js/plugin-github 编辑 构建工具来啊!

使用

注册插件 require- 说:

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

插件随后可用作如下:

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 共发布 5 个版本,首次发布于 2023/03/27;过去 12 个月发布了 4 个版本。

版本发布日期距今
0.7.2latest2026/09/201 个月前
0.7.12026/09/111 个月前
0.7.02026/09/111 个月前
0.6.22026/01/169 个月前
0.6.12023/03/273 年前

关于 @citation-js/plugin-github 的常见问题

@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 和提交记录判断。