readme-badger 是一个可以在 README.md 文件中添加徽章（badge）的 Node.js 模块。徽章可以用来显示项目状态、版本号和构建状态等，可以提升项目的可读性和专业感。
安装
使用 npm 进行全局安装：
npm i -g readme-badger
在项目目录下执行以下命令安装本地依赖：
npm i --save-dev readme-badger
使用
基本使用
在 README.md 文件中添加如下标记：
<!--@import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false}-->
<!--@import "[badger]" {style="flat-square"} --> 运行以下命令即可生成徽章：
readme-badger
效果如下：
自定义徽章
readme-badger 支持自定义徽章，可以根据个人需要修改样式和参数。以下是几个常见的示例：
- 显示测试覆盖率
<!--@import "[badger]" {style="flat-square", imgStyle="vertical-align:middle", link="https://codecov.io/gh/OpenBrush/readme-badger", imgAlt="Codecov", badgeClass="coverage-badge"} -->效果如下：
- 显示 Travis CI 构建状态
<!--@import "[badger]" {style="flat-square", imgStyle="vertical-align:middle", link="https://travis-ci.com/OpenBrush/readme-badger", imgAlt="travis-ci", badgeClass="build-badge"} -->效果如下：
参数说明
readme-badger 的主要参数如下：
| 参数名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
source |
string | README.md | README 文件路径 |
destination |
string | README.md | 目标文件路径，一般与 source 相同 |
label |
string | - | 徽章标签名称 |
message |
string | - | 徽章显示的信息 |
color |
string | brightgreen | 徽章颜色 |
style |
string | flat-square | 徽章样式，详见 shields.io |
imgStyle |
string | - | 徽章图片的样式 |
link |
string | - | 徽章点击跳转的链接 |
imgAlt |
string | - | 徽章图片的 alt 属性值 |
badgeClass |
string | - | 徽章容器的 class 属性值 |
注意事项
readme-badger 的徽章是通过访问 shields.io 生成的，因此需要保证网络畅通。如果 shields.io 访问缓慢或者无法访问，可能会导致徽章无法正常显示。
总结
使用 readme-badger 可以快速方便地在 README.md 文件中添加徽章，提升项目的可读性和专业感。同时，可以根据个人需要自定义徽章样式和参数，满足特殊需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/42474