如果你是一个开源项目的开发者，你一定会经常使用 npm 来管理你的依赖。但是，当你想了解一个依赖包的作者时，你会发现它并不是那么容易。幸运的是，我们已经有了一个叫做 authors-to-markdown 的 npm 包，它可以帮助我们把一个 npm 包的作者信息转换为 markdown 格式，以便于在 README 或者其他文档中使用。
安装
我们可以使用 npm 来安装这个包：
--- ------- -- -------------------
这样，我们就可以在命令行中使用 authors-to-markdown 命令了。
使用
我们可以在命令行中进入到一个 npm 包的根目录，然后执行以下命令：
-------------------
这将会输出一个类似这样的 markdown 文档：
-- ------- - --------------------------------- - -----------------------------
这个文档列出了这个 npm 包的所有作者，并且为每个作者提供了一个链接，链接至其 GitHub 主页。
如果你想打印出 JSON 格式的作者信息而不是 markdown 格式的文档，你可以使用 --json 参数：
------------------- ------
这将输出一个类似这样的 JSON 数据：
--------- -------- ------ ---------------------------- -------- ------ ------ --------------------------
扩展用法
authors-to-markdown 有一些可选的参数来扩展其用法。下面是它们的介绍。
--heading
这个参数可以指定 markdown 标题的级别。例如：
------------------- --------- -
这将会输出一个三级标题（### Authors）。
--reverse
这个参数可以反转作者列表的顺序。例如：
------------------- ---------
这将会输出一个反转后的作者列表。
--limit
这个参数可以限制作者列表的数量。例如：
------------------- ------- -
这将会输出最多三个作者的列表。
结束语
以上就是我们对 npm 包 authors-to-markdown 的使用教程。通过这个工具，我们可以更加方便地了解一个 npm 包的作者，然后在我们的文档中使用。这不仅方便了用户，也是给作者们的一种认可和赞扬。希望这篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/69113