简介
markdown-contributors 是一个 npm 包，旨在为 Markdown 文件添加贡献者列表。它可以根据 Git 历史记录识别哪些人最近修改了文件，并生成一个包含这些人名和链接的 Markdown 格式的贡献者列表。这个包可以帮助开发者在 Markdown 文档中更好地追踪贡献者，方便团队协作。
安装
在命令行中输入以下命令进行安装：
--- - --------------------- ----------
此命令将 markdown-contributors 安装为 devDependencies。如果您正在开发一个具有 Markdown 文件的项目，可以将其设置为项目的一部分；否则，只需全局安装：
--- - -- ---------------------
在这种情况下，您可以在命令行中随时使用 markdown-contributors 命令。
使用
将 contributors 列表添加到 Markdown 文件中
要将 contributors 列表添加到 Markdown 文件中，只需在该文件中运行以下命令：
--- --------------------- --------------------------
此命令将在 Markdown 文件顶部添加一个 contributors 列表。
配置 contributors 样式
markdown-contributors 支持两种不同的格式：
- 行内列表（逗号分隔列表）
- 块级别列表
默认情况下，markdown-contributors 使用行级别格式。您可以在 markdown-contributors 命令中使用 -s/--style 参数选择样式。例如，要使用块级别样式：
--- --------------------- -------------------------- ------- -----
设置用户链接
默认情况下，markdown-contributors 将通过 GitHub API 为每个用户创建链接。如果您使用不同的 Git 提供程序或想要自定义链接，请使用 -u/--user-link 参数。例如：
--- --------------------- -------------------------- -- -------------------------------------
在这个示例中，%s 将被替换为每个用户的用户名。
示例代码
以下是一个来自 Node.js 项目的示例 markdown-contributors 列表：
-- ------------ - ------- ------------------------------------------ - - ---- ----------------------------------- - -------- ---------------------------------------
在这个示例中，Ashley Madison 通过添加 † 标记表示已不再活跃。如果您不想使用此标记，您可以从命令行中使用 -a/--active 参数：
--- --------------------- -------------------------- -- -----
这将在贡献者列表中忽略不再活跃的用户。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005607c81e8991b448deb05