npm 是 Node.js 的包管理工具，通过它可以方便地查找、安装和更新 Node.js 模块。其中 vigour-doc-badges 是一款用于创建项目徽章 (badge) 的 npm 包，本篇文章将详细介绍它的使用方法。
1. 安装 vigour-doc-badges
首先，需要在命令行中输入以下命令来安装 vigour-doc-badges：
--- ------- ---------- -----------------
这里通过 --save-dev 参数将 vigour-doc-badges 安装到当前项目的开发依赖中，以便在项目构建过程中使用其提供的命令。
2. 创建项目徽章
vigour-doc-badges 的功能就是提供了一些易于定制的项目徽章。使用这些徽章，我们可以在项目的 README.md 文件或者文档页面上展示一些关于项目的信息，比如项目的构建状态、测试覆盖率等。
在本地项目目录下执行以下命令即可创建一个徽章：
----------------- --- ------------ ------------
其中，<badge-name> 是自定义徽章名称（不含空格），<badge-text> 是徽章显示的文本。
例如，下面的命令创建了一个名为 build-status 的徽章，显示的文本是 build-passing：
----------------- --- ------------ -------------
执行完上述命令后，README.md 文件中将多出一行徽章的 Markdown 代码：
-------------------------------------------------------------------------------
我们可以通过修改 add 支持的参数来更改徽章的样式。具体的参数说明请参考 vigour-doc-badges 的文档。
3. 自定义项目徽章
默认情况下，vigour-doc-badges 提供了多种类型的徽章，但是有时候我们需要根据项目的特殊需求来定制自己的徽章。
为此，可以在项目的根目录下创建一个名为 .badge.cnf 的配置文件，指定自己需要的徽章类型：
------------ ---- - ---------- ----- - -----------
其中，[badge_name] 是自定义的徽章名称（不含空格），badge_text 是徽章显示的文本，badge_color 是徽章的背景颜色。设置好配置文件之后，我们可以使用 add 命令创建自己的徽章。
例如，下面的配置文件就定制了一个名为 my-badge 的徽章，显示的文本是 My Badge，背景颜色为蓝色：
---------- ---- - -- ----- ----- - ----
创建这个徽章的命令如下：
----------------- --- --------
执行完上述命令后，README.md 文件中将多出一行自定义的徽章的 Markdown 代码：
-----------------------------------------------------------------
4. 结束语
通过本文的介绍，我们了解了 vigour-doc-badges 的基本用法和自定义方式，掌握了如何在项目中使用徽章功能。希望本篇文章对前端开发者有所帮助，建议读者阅读 vigour-doc-badges 的官方文档以获取更多详细信息。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/71450