remark-git-contributors
是一款 npm 包,它可以方便地生成 Git 项目的贡献者列表。本文将详细介绍这个包的使用方法,包括安装、配置和使用示例。
安装
可以通过 npm 进行安装:
--- ------- ----------------------- ----------
配置
在使用 remark-git-contributors
之前,你需要先配置它。在项目根目录下创建一个 .remarkrc.js
文件,并添加以下配置:
-------------- - - -------- - - -------------------------- - ---------- ----- ------------ -- ----------- --- ---------- ------ ------ ----------- -------- -- -- -- --
perAuthor
:如果为true
,则会按作者分组显示贡献者列表。commitLimit
:只显示至少有指定数量的提交的作者。avatarSize
:设置头像大小(以像素为单位)。showCount
:如果为true
,则会在每个作者的姓名后面显示其提交的次数。order
:贡献者列表的排列方式。可选值为commits
、name
和email
。
使用示例
在 Markdown 文件中插入以下代码来生成贡献者列表:
-- ------------ ---- --------------------- --- --------------- ---- ------------------- ---
其中 ${contributors}
是 remark-git-contributors
插件生成的占位符。
运行命令 npx remark .
来处理 Markdown 文件,然后你就可以在生成的 HTML 文件中看到贡献者列表了。
总结
这篇文章介绍了如何使用 remark-git-contributors
生成 Git 项目的贡献者列表。通过阅读本文,你应该已经学会了如何安装、配置和使用这个 npm 包,并成功生成了自己的贡献者列表。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/45637