什么是remark-contributors？
remark-contributors 是一个能够自动生成 Markdown 文件中的贡献者列表的工具。使用该工具，我们可以轻松地在我们的项目中添加一个贡献者列表。
安装
使用 npm 安装 remark-contributors：
npm install remark-contributors --save-dev
使用
在Markdown文件中添加贡献者列表
要在 Markdown 文件中添加贡献者列表，需要遵循以下步骤：
在 markdown 文件中添加如下占位符：
<!-- contributors:START - Do not remove or modify this section --> <!-- contributors:END -->
运行以下命令：
npx remark . --use remark-contributors --output
运行该命令后，将会在该占位符所在行下方生成一个贡献者列表。
修改贡献者列表格式
要修改贡献者列表的格式，需要在运行命令时传入 remark-contributors 的选项。
例如，要修改贡献者列表的标题为 “Contributors”，可以按照以下方式运行命令：
npx remark . --use remark-contributors --set contributors.title=Contributors --output
示例代码
以下示例代码演示了如何在 Markdown 文件中使用 remark-contributors 添加贡献者列表：
-- -------------------- ---- ------- - -- ------- ---- ------------------ - -- --- ------ -- ------ ---- ------- --- ---- ---------------- --- -- ------- ------- -- --- -------- ------ ----- ------------- -- ----- ---- ----------- -- --- ---- --------- -- ------------ -- ------- -------------- -- ---------- -- ---- -------- ------ ------ ----- ------ -- ---- ---- ----------- -- ------ - --- ------- ---- -------- -- ------------------- -- ---- ---- ------- --- ------ ----- ---- ------ --- ---- ---- ---------- -- ---- -- --- ------ ------- ---- ---- ------ ------------------- -- ------ - ---- -------- ---- -------------------- ----- --- ---- ------------ ----- --- ---- ------------ --- --- ---- ------------------- ----- ---
运行命令：
npx remark . --use remark-contributors --set contributors.title=Contributors --output
将会生成如下贡献者列表：
-- -------------------- ---- ------- - -- ------- -- ------- ------- -- --- -------- ------ ----- ------------- -- ----- ---- ----------- -- --- ---- --------- -- ------------ -- ------- -------------- -- ---------- -- ---- -------- ------ ------ ----- ------ -- ---- ---- ----------- -- ------ - --- ------- ---- -------- -- ------------------- -- ---- ---- ------- --- ------ ----- ---- ------ --- ---- ---- ---------- -- ---- -- --- ------ ------- ---- ---- ------ ------------------- -- ------ - ---- -------- -- ------------ - ----- -------------------------- - --- ------------------------ - ------- ----------------------------
总结
remark-contributors 是一个方便的工具，可以帮助我们轻松自动生成贡献者列表。在项目中添加贡献者列表可以让贡献者获得更多的认可和鼓励，并且对于项目本身的推广也有很大的帮助。如果你是一个开源项目的维护者或者参与者，不妨考虑在项目中添加一个贡献者列表。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45391