在前端开发中，我们经常需要写文档以便让其他人了解我们的项目，而其中一个重要的方面就是项目的贡献者。这时如果能自动地从 GitHub 中获取贡献者的信息，并将其加入到文档中显示，那么将会大大提升文档的可读性和互动性。这就是 markdown-magic-github-contributors 这个 npm 包的作用，本文将为您详细介绍它的使用方法。
什么是 markdown-magic-github-contributors
markdown-magic-github-contributors 是一个 npm 包，用于在 markdown 文件中显示 GitHub 项目的贡献者信息，包括 GitHub 用户名、头像、主页链接等。它使用 GitHub API 获取贡献者的信息，并将其渲染成 markdown 格式。
使用 markdown-magic-github-contributors，您可以：
- 在 markdown 文件中自动显示项目的贡献者信息。
- 自定义贡献者列表的样式和布局。
- 控制是否显示私有贡献者（即未公开姓名或头像的贡献者）。
如何使用 markdown-magic-github-contributors
- 安装 markdown-magic-github-contributors：
npm install markdown-magic-github-contributors --save-dev
- 将 markdown-magic-github-contributors 添加为 markdown-magic 插件：
-- -------------------- ---- ------- ---- -------------- - ----- ------------ - --------------------------------------------- - ----- ------- - - -- --- -- - --- --- ---- --------------------- --- ------------------------ ---- ------------------- ---
- 配置 options 对象：
-- -------------------- ---- -------
---- --------------
- ----- ------------ - ---------------------------------------------
- ----- ------- - -
----- ------------
----------- -----
--------- -----
---------- -----
--------- ---
----------- ---------------
--------------- -----
-
---
---- --------------------- ---
------------------------
---- ------------------- ---options 对象的各个配置项的作用如下：
slug：GitHub 项目的 slug，格式为 "user/repo"。showAvatar：是否显示贡献者的头像。showLink：是否将贡献者的用户名转换为链接，指向其 GitHub 主页。showCount：是否显示贡献者的贡献次数。maxCount：最大显示贡献者数量。tableClass：贡献者列表表格的 CSS 类名。excludePrivate：是否排除私有贡献者。
- 运行 markdown-magic：
npm run markdown-magic && git add README.md
使用 markdown-magic-github-contributors 的示例代码如下：
-- -------------------- ---- -------
---- --------------
- ----- ------------ - ---------------------------------------------
- ----- ------- - -
----- ----------------------
----------- -----
--------- -----
---------- -----
--------- ---
----------- ---------------
--------------- -----
-
---
-- ---
---- --------------------- ---
------------------------
---- ------------------- ---总结
markdown-magic-github-contributors 是一个方便的 npm 包，可以自动从 GitHub 中获取项目的贡献者信息，并将其加入到 markdown 文件中，方便用户了解项目的贡献者。它的使用方法也很简单，只需要配置 options 对象即可。我相信当您将此 npm 包运用到自己的项目中后，文档的可读性和互动性将会有质的飞跃。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb456b5cbfe1ea061125e