# @cssnr/vitepress-plugin-contributors 中文文档 规范地址：https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/ 版本：0\.2\.0 npm 元数据更新时间：2026-04-20T02:15:42.525Z 中文译文更新时间：2026-11-11T03:57:49.421Z 软件包许可：GPL-3\.0-only 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40cssnr/vitepress-plugin-contributors 原文对照：https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/?lang=original 项目主页：https://github.com/cssnr/vitepress-plugin-contributors 源码仓库：https://github.com/cssnr/vitepress-plugin-contributors ## 关键信息（来自 npm 元数据） - 包体积（解压后）：61.1 kB，10 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：1 个 - 首次发布：2025-09-13T04:12:26.318Z - 最新版本发布：2026-04-20T02:15:42.228Z - 近 30 天下载量：5503（2026-10-11 至 2026-11-09，npm 官方下载统计） - 已发布版本数：7（近 12 个月 2 个） ## 中文简介 VitePress 插件以方便生成,更新并显示 GitHub 贡献者 。 自动更新每次安装或部署的自定义选项. ## 安装 ```sh npm install @cssnr/vitepress-plugin-contributors ``` 也可以使用：`pnpm add @cssnr/vitepress-plugin-contributors`、`yarn add @cssnr/vitepress-plugin-contributors`、`bun add @cssnr/vitepress-plugin-contributors` ## README [![NPM Version](https://img.shields.io/npm/v/%40cssnr%2Fvitepress-plugin-contributors?logo=npm)](https://www.npmjs.com/package/@cssnr/vitepress-plugin-contributors) [![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/vitepress-plugin-contributors?logo=github)](https://github.com/cssnr/vitepress-plugin-contributors/releases) [![NPM Downloads](https://img.shields.io/npm/dm/%40cssnr%2Fvitepress-plugin-contributors?logo=npm)](https://npm-stat.com/charts.html?package=%40cssnr%2Fvitepress-plugin-contributors) [![Bundlephobia Size](https://img.shields.io/bundlephobia/min/%40cssnr%2Fvitepress-plugin-contributors?logo=bookstack&logoColor=white)](https://bundlephobia.com/package/@cssnr/vitepress-plugin-contributors) [![Deployments NPM](https://img.shields.io/github/deployments/cssnr/vitepress-plugin-contributors/npm?logo=npm&label=deploy)](https://github.com/cssnr/vitepress-plugin-contributors/deployments/npm) [![Deployments Docs](https://img.shields.io/github/deployments/cssnr/vitepress-plugin-contributors/docs?logo=vitepress&logoColor=white&label=docs)](https://github.com/cssnr/vitepress-plugin-contributors/deployments/docs) [![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/vitepress-plugin-contributors/release.yaml?logo=norton&logoColor=white&label=release)](https://github.com/cssnr/vitepress-plugin-contributors/actions/workflows/release.yaml) [![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/vitepress-plugin-contributors/lint.yaml?logo=norton&logoColor=white&label=lint)](https://github.com/cssnr/vitepress-plugin-contributors/actions/workflows/lint.yaml) [![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/vitepress-plugin-contributors?logo=listenhub&label=updated)](https://github.com/cssnr/vitepress-plugin-contributors/pulse) [![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/vitepress-plugin-contributors?logo=buffer&label=repo%20size)](https://github.com/cssnr/vitepress-plugin-contributors?tab=readme-ov-file#readme) [![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/vitepress-plugin-contributors?logo=devbox)](https://github.com/cssnr/vitepress-plugin-contributors?tab=readme-ov-file#readme) [![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/vitepress-plugin-contributors?logo=southwestairlines)](https://github.com/cssnr/vitepress-plugin-contributors/graphs/contributors) [![GitHub Issues](https://img.shields.io/github/issues/cssnr/vitepress-plugin-contributors?logo=codeforces&logoColor=white)](https://github.com/cssnr/vitepress-plugin-contributors/issues) [![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/vitepress-plugin-contributors?logo=theconversation)](https://github.com/cssnr/vitepress-plugin-contributors/discussions) [![GitHub Forks](https://img.shields.io/github/forks/cssnr/vitepress-plugin-contributors?style=flat&logo=forgejo&logoColor=white)](https://github.com/cssnr/vitepress-plugin-contributors/forks) [![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/vitepress-plugin-contributors?style=flat&logo=gleam&logoColor=white)](https://github.com/cssnr/vitepress-plugin-contributors/stargazers) [![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=apachespark&logoColor=white&label=org%20stars)](https://cssnr.github.io/) [![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY) [![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr) # VitePress 插件贡献器 [![VitePress Plugin Contributors](https://vitepress-contributors.cssnr.com/images/logo.png)](https://vitepress-contributors.cssnr.com/ "VitePress Plugin Contributors") - [安装](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-Install) - [使用量](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-Usage) - [选项](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-Options) - [演示文稿](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-Demos) - [支助](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-Support) - [捐款](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-Contributing) A 类 [虚拟新闻](https://vitepress.dev/) 用于轻松生成、更新和显示寄存器的插件. 支持GitHub(包括企业)和Forgejo(Gitea,Codeberg等). 这个 [软件包](https://www.npmjs.com/package/@cssnr/vitepress-plugin-contributors) 包括可以一起或单独使用的两个组件. 1. [获得贡献者](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/src/get-contributors.ts) - 生成 `contributors.json` 文档. 2. [贡献者.vue](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/src/Contributors.vue) - 在VitePress中显示贡献者的组件. 还包括一个详细的 [安装](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-install) 可用指南 [支助](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-support)。 。 。 . [![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://vitepress-contributors.cssnr.com/) ## 安装 [![View Install Guide](https://img.shields.io/badge/view_install_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://vitepress-contributors.cssnr.com/guides/get-started#install) 1. 直接安装到您的 VitePress 从 [无](https://www.npmjs.com/package/@cssnr/vitepress-plugin-contributors)。 。 。 . ```shell npm i @cssnr/vitepress-plugin-contributors ``` 2. 添加数据 [获得贡献者](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/src/get-contributors.ts) 脚本到您的 `package.json`。 。 。 . ```json { "scripts": { "get-contributors": "npx get-contributors user/repo", "postinstall": "npm run get-contributors" } } ``` _如果你们不添加 `postinstall` 您需要添加脚本 `get-contributors` 到你的建筑._ 点击这里查看使用量 - **获得贡献者** [![View Get Contributors Docs](https://img.shields.io/badge/view_get_contributors_docs-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://vitepress-contributors.cssnr.com/docs/get-contributors) 显示帮助 : `npx get-contributors -h` 基本用途,所有贡献者不包括机器人用户. ```shell npx get-contributors user/repo ``` 限制为前20名贡献者,指定输出文件,并包括bot用户. ```shell npx get-contributors user/repo -m 20 -f .vitepress/contributors.json -b ``` 只有 `user/repo` 需要时间。 所有其他论点都是可选的. | 参数旗 | 默认值 | 参数描述 | | :-- | :-: | :-: | | `-f`编号 :`--file` | `.vitepress/contributors.json` | 相对于工程根输出文件 | | `-m`编号 :`--max-users` | `0` | 要获取的最大用户, 0 是无限的 | | `-b`编号 :`--bots` | \- 说吧 | 将机器人用户纳入结果 | | `-e`编号 :`--error` | \- 说吧 | 生成时丢出错误 | | `-k`编号 :`--keys` | `login,avatar_url` | 要保存到文件的密钥 | | `-G`编号 :`--github` | `https://api.github.com` | GitHub API URL( 用于企业) | | `-F`编号 :`--forgejo` | \- 说吧 | Forgejo API URL(给吉特亚/科德伯格) | 说明: 此脚本向 GitHub API 提出一个请求, 每100名寄件者在寄存器( 或 `max-users`) (中文(简体) ). 因为如果你有很多贡献者(200+) 运行在背对背上,可能会被击中 页:1 [GitHub 利率限制](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-primary-rate-limits) 对未经认证的请求,即每小时60个请求. 如果发生这种情况, 脚本将生成一个部分或空的投稿人, 这样可以继续开发 . **这不影响 GitHub 动作运行,这些运行被认证为 `GTIHUB_TOKEN`。 。 。 .** * * * 3. 添加数据 `contributors.json` 文件位置到您的 `.gitignore`。 。 。 . ```txt .vitepress/contributors.json ``` 4. 生成 `contributors.json` 文档. ```shell npm run get-contributors ``` 或者,如果你没有添加 `get-contributors` 第2步的脚本. ```shell npx get-contributors user/repo ``` 5. 导入您的组件 `.vitepress/theme/index.js`。 。 。 . ```javascript import DefaultTheme, { VPBadge } from 'vitepress/theme' // only if using VPBadge import Contributors from '@cssnr/vitepress-plugin-contributors' // ADD this line import '@cssnr/vitepress-plugin-contributors/style.css' // ADD this line import contributors from '../contributors.json' // OPTIONAL - Global export default { ...DefaultTheme, enhanceApp({ app }) { app.component('Badge', VPBadge) // only if using VPBadge app.component('Contributors', Contributors) // ADD this line app.config.globalProperties.$contributors = contributors // OPTIONAL - Global }, } ``` `Global` - 如果你不确定这一点 [使用量](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-usage)中,添加这些行以简单化. `VPBadge` - 只有在您使用 VitePress 时才需要 [徽标](https://vitepress.dev/reference/default-theme-badge#badge)。 。 。 . 更多细节 **贡献者.json** 路径 注意,你可能需要修改 `../contributors.json` 导入位置以匹配您的设置 . 如果您的 VitePress 配置目录位于 `.vitepress` 然后是默认输出 路径 `.vitepress/contributors.json` 从相对路径导入 `../contributors.json`。 。 。 . 如果您没有导入 `contributors` 作为环球,此路径将相对于您导入的文件 . 见 [使用量](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-usage) 更多细节. * * * 6. 最后,请使用 [贡献者.vue](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/src/Contributors.vue) 图标. ```markdown ``` 见 [使用量](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-usage) 更多细节... ## 使用量 [![View Usage Guide](https://img.shields.io/badge/view_usage_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://vitepress-contributors.cssnr.com/guides/get-started#usage) 要使用,只需添加 `` 标记到你的标记下的文件(或组件). 如果你添加的话 `contributors` 作为全球的组成部分,你只需要 `` 标签. ```markdown ``` 否则,导入 `contributors.json` 添加一个 `` 标签. ```markdown ``` 这个 `contributors.json` 文件相对于您导入的文件. 见 [选项](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-options) 更多细节... ## 选项 [![View Contributors Docs](https://img.shields.io/badge/view_contributors_docs-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://vitepress-contributors.cssnr.com/docs/contributors) 只有 `:contributors` 需要参数,其他的都是可选的. | 参数 | 默认 | 类型 | 参数说明 | | :-- | :-: | :-: | :-- | | **: 贡献者** | **需求** | 阵列 | `contributors.json` 文件导入数据 | | **最大用户** | \- 说吧 | 字符串 | 要显示的用户数 | | **标题** | \- 说吧 | 字符串 | 可选标题文本 | | **大小** | `64` | 字符串 | 用像素表示的图标大小 | | **边距** | \- 说吧 | 字符串 | [CSS 比值](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) 容器字符串 | 以所有论据为例. ```markdown ``` [![VitePress Contributors](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/vp-contributors/shots/contributors98.jpg)](https://github.com/cssnr/vitepress-plugin-contributors?tab=readme-ov-file#readme) ## 演示文稿 插件正在这些页面上运行 : - [https://django-files.github.io/ 互联网档案馆的存檔,存档日期2013-12-22](https://django-files.github.io/) 财务报告和审定财务报表 [团队](https://django-files.github.io/team) - [https://docker-deploy.cssnr.com/ 页面存档备份,存于互联网档案馆](https://docker-deploy.cssnr.com/) - [https://portainer-deploy.cssnr.com/ (中文(简体) )](https://portainer-deploy.cssnr.com/) 如果你有现场演示, [告诉我们](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-support) 我们把它放在这里... ## 支助 日志可以查看页面(Ctrl+Shift+I),点击控制台; Firefox:将调试日志,Chrome:将Verbose从水平降下. 如果您遇到任何问题或需要帮助,请做以下一项: - 报告一个问题: [https://github.com/cssnr/vitepress-plugin-controducers/ issues (中文(简体) )](https://github.com/cssnr/vitepress-plugin-contributors/issues) - 讨论: [https://github.com/csnr/vitepress-plugin-controducers/discussions/ classes/q-a) 互联网档案馆的存檔,存档日期2013-12-22](https://github.com/cssnr/vitepress-plugin-contributors/discussions/categories/q-a) - 请求特性 : [https://github.com/csnr/vitepress-plugin-controducers/issues/new?template=1-feature.yaml 互联网档案馆的存檔,存档日期2013-12-11](https://github.com/cssnr/vitepress-plugin-contributors/issues/new?template=1-feature.yaml) - 在Discord上和我们聊天: [https://discord.gg/wXy6m2X8wy (中文(简体) )](https://discord.gg/wXy6m2X8wY) [![Features](https://img.shields.io/badge/features-brightgreen?style=for-the-badge&logo=rocket&logoColor=white)](https://github.com/cssnr/vitepress-plugin-contributors/issues/new?template=1-feature.yaml) [![Issues](https://img.shields.io/badge/issues-red?style=for-the-badge&logo=southwestairlines&logoColor=white)](https://github.com/cssnr/vitepress-plugin-contributors/issues) [![Discussions](https://img.shields.io/badge/discussions-blue?style=for-the-badge&logo=livechat&logoColor=white)](https://github.com/cssnr/vitepress-plugin-contributors/discussions) [![Discord](https://img.shields.io/badge/discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY) ### 更多虚拟新闻插件 - [丝线JS](https://github.com/cssnr/vitepress-swiper) - 相册 - [贡献者](https://github.com/cssnr/vitepress-plugin-contributors) - GitHub 贡献者 - [复制按钮](https://github.com/cssnr/vitepress-plugin-copybutton) - 复制文本按钮 # 捐款 欢迎所有捐款,包括: [错误报告](https://github.com/cssnr/vitepress-plugin-contributors/issues), (中文(简体) ), [特性请求](https://github.com/cssnr/vitepress-plugin-contributors/issues/new?template=1-feature.yaml),或调取请求. 用于创建 PR 的指令 [软件包](https://www.npmjs.com/package/@cssnr/vitepress-plugin-contributors) 或者说 [文档](https://vitepress-contributors.cssnr.com/), (中文(简体) ), 见 [捐款额](https://npmcn.com/package/%40cssnr/vitepress-plugin-contributors/#readme-contributing-ov-file)。 。 。 . 请考虑捐款支持该项目和更多开放源码项目的发展. [![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr) 关于目前项目访问的完整清单: [https://cssnr.github.io/ (中文(简体) )](https://cssnr.github.io/) [![Star History Chart](https://api.star-history.com/svg?repos=cssnr/vitepress-plugin-contributors&type=date&legend=bottom-right)](https://github.com/cssnr/vitepress-plugin-contributors/stargazers) ## 常见问题 ### @cssnr/vitepress-plugin-contributors 是什么？ VitePress 插件以方便生成,更新并显示 GitHub 贡献者 。 自动更新每次安装或部署的自定义选项\. ### 如何安装 @cssnr/vitepress-plugin-contributors？ 在项目目录运行 npm install @cssnr/vitepress-plugin-contributors，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 get-contributors，可以用 npx get-contributors 直接运行。 ### @cssnr/vitepress-plugin-contributors 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @cssnr/vitepress-plugin-contributors 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @cssnr/vitepress-plugin-contributors 可以商用吗？ @cssnr/vitepress-plugin-contributors 使用 GPL-3\.0-only 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。 ### @cssnr/vitepress-plugin-contributors 的下载量有多少？ 根据 npm 官方下载统计，@cssnr/vitepress-plugin-contributors 在 2026/10/11 – 2026/11/09 这 30 天内被下载 5,503 次，日均约 183 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @cssnr/vitepress-plugin-contributors 还在维护吗？ 最新版本 0\.2\.0 发布于 2026/04/20（6 个月前）；至今共发布 7 个版本，其中过去 12 个月发布了 2 个；首次发布于 2025/09/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。