# zotero-plugins

**Repository Path**: zotero-chinese-x/zotero-plugins

## Basic Information

- **Project Name**: zotero-plugins
- **Description**: Zotero 插件商店。
使用 Node.js + TypeScript + Octokit 向 GitHub 获取 Zotero 插件信息；基于 Vue + TypeScript + Element  Plus + Vite 构建前端网页。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://zotero-chinese.com/plugins
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 0
- **Created**: 2023-10-06
- **Last Updated**: 2026-05-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: zotero, zotero-plugin, zotero-chinese, Zotero插件, zotero中文

## README

# Zotero 插件合集

![GitHub 自动构建状态](https://img.shields.io/github/actions/workflow/status/northword/zotero-plugins/main.yml?logo=githubactions)
[![Netlify 部署状态](https://api.netlify.com/api/v1/badges/bae2ef92-2f0a-4076-ae7c-6619933cdf39/deploy-status)](https://app.netlify.com/sites/zotero-plugins/deploys)
![GitHub 最后更新时间](https://img.shields.io/github/last-commit/northword/zotero-plugins/main?logo=github)
![最后更新](https://img.shields.io/badge/dynamic/json?logo=github&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnorthword%2Fzotero-plugins%2Fgh-pages%2Fdist%2Fshields.json&query=%24.lastUpdate&label=%E6%9C%80%E5%90%8E%E6%9B%B4%E6%96%B0)
![jsDelivr hits (GitHub)](https://img.shields.io/jsdelivr/gh/hw/zotero-chinese/zotero-plugins?logo=jsdelivr)

_This README is also available in: :cn: 简体中文 | [:gb: English](./README-zh.md)。_

本仓库提供了若干 Zotero 插件的信息及其 XPI 包，尝试在 Zotero 官方插件商店建立前，提供集中的插件商店服务。

## 访问

**Zotero 中文社区主域名：<https://zotero-chinese.com/plugins>**

## 状态

该仓库暂时处于冻结状态，不再接收插件提交，现有插件信息将继续更新至 2026 年 6 月，之后该仓库将存档。

网站更新不受影响，网站将使用 [syt2/zotero-addons-scraper](https://github.com/syt2/zotero-addons-scraper) 仓库的信息进行构建，直至 Zotero 官方商店建立。

新的插件请提交至 [syt2/zotero-addons-scraper](https://github.com/syt2/zotero-addons-scraper) 仓库，谢谢！

## 提交插件

> [!WARNING]
>
> 此仓库不再接收插件提交请求，新的插件请提交至 [syt2/zotero-addons-scraper](https://github.com/syt2/zotero-addons-scraper) 仓库，谢谢！

[![在 GitHub Codespaces 中打开](https://github.com/codespaces/badge.svg)](https://codespaces.new/zotero-chinese/zotero-plugins?quickstart=1)

> [!NOTE]
>
> 如何添加未收录的插件？
>
> 编辑 [`src/plugins.ts`](./src/plugins.ts)，在 `plugins` 列表中添加一个对象，内容格式如下所示，已有的内容亦可作为参考。
>
> 添加时请按 `repo` 排序。
>
> 编辑完成后提交，发起 Pull Request，仓库成员将尽快处理。

```ts
interface PluginInfo {
  /**
   * 插件仓库
   *
   * 例如：northword/zotero-format-metadata
   *
   * 注意前后均无 `/`
   */
  repo: string
  /**
   * 插件的发布地址信息
   */
  releases: Array<{
    /**
     * 当前发布版对应的 Zotero 版本，"7" 或 "6"
     */
    targetZoteroVersion: string
    /**
     * 当前发布版对应的下载通道
     *
     * `latest`：最新正式发布；
     * `pre`：最新预发布；
     * `string`：发布对应的 `git.tag_name`；
     * 注意 `git.tag_name` 有的有 `v` 而有的没有，可以通过发布链接来判断
     */
    tagName: 'latest' | 'pre' | string
  }>
}
```

## 开发指南

开发前，需要根据 [GitHub 文档](https://docs.github.com/zh/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) 创建 GitHub 个人访问令牌，将其存入本地环境变量 `GITHUB_TOKEN`。

```bash
# 克隆仓库
git clone https://github.com/northword/zotero-plugins.git zotero-plugins
cd zotero-plugins

# 安装依赖
corepack enable
pnpm install

# 获取插件信息
pnpm data:info

# 获取图表信息
pnpm data:chart
```

[`src/index.ts`](./src/index.ts) 为主要逻辑脚本，它执行如下操作：

- 遍历上述插件信息列表，从 GitHub 获取每一个插件的基本信息和发行版，将获取到的信息保存在 [`dist/plugins.json`](https://github.com/northword/zotero-plugins/blob/gh-pages/dist/plugins.json)
- 同时将 XPI 包保存在 [`dist/xpi/${github.release.asset.id}.xpi`](https://github.com/northword/zotero-plugins/blob/gh-pages/dist/xpi)

GitHub Action Bot 定时运行 `src/index.ts` 脚本，执行上述步骤，并将 `dist/` 部署到 [`gh-page`](https://github.com/northword/zotero-plugins/blob/gh-pages/) 分支。

> [!NOTE]
>
> 如何将本项目作为依赖项进行二次开发？
>
> 开发者可以使用 [`gh-pages` 分支中 `dist/plugins.json`](https://github.com/northword/zotero-plugins/blob/gh-pages/dist/plugins.json) 等构建文件。

## 致谢

感谢 Zotero 社区及开发者们的付出！

本项目使用了如下代理或公共 CDN 服务完成 XPI 分发：

- GitHub 代理：<https://github.com/hunshcn/gh-proxy>
- JsDeliver：<https://www.jsdelivr.com/>
- KGitHub: <https://help.kkgithub.com/>

本项目是对 [l0o0/ZoteroPlugins](https://github.com/l0o0/ZoteroPlugins) 的 Typescript 重新实现。

本项目部署在 GitHub Pages 和 Netlify.

[![netlify](https://www.netlify.com/v3/img/components/netlify-color-bg.svg)](https://www.netlify.com)

## 贡献者

[![本项目贡献者](https://contrib.rocks/image?repo=zotero-chinese/zotero-plugins)](https://github.com/zotero-chinese/zotero-plugins/graphs/contributors)

## 协议

MIT License

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=zotero-chinese/zotero-plugins&type=Date)](https://star-history.com/#zotero-chinese/zotero-plugins&Date)