如何给你的github readme 增加状态徽章?

431 阅读1分钟

在GitHub项目的README中,你经常可以看到各种徽章(badges),它们用于展示项目的多种信息,例如npm包的版本、下载量、单元测试状态等。这些徽章是通过在Markdown文件中嵌入特定格式的URL链接来生成的。以下是一些常见的徽章及其生成方法:

1. npm版本

要显示npm包的最新版本,可以使用如下链接:

[![npm version](https://img.shields.io/npm/v/@your/package)]
(https://badge.fury.io/js/@your/package)

替换@your/package为你的npm包名。

2. npm下载量

展示npm包每月的下载量,使用:

[![npm downloads](https://img.shields.io/npm/dm/@your/package)]
(https://npm-stat.com/charts.html?package=@your/package)

同样替换@your/package为你的npm包名。

3. license

展示项目协议

[![npm downloads](https://img.shields.io/npm/l/@your/package)]
(https://github.com/username/project/README)

同样替换@your/package为你的npm包名。

4. 单元测试状态

例如,使用Travis CI展示测试状态:

[![Build Status](https://travis-ci.org/yourusername/yourproject.svg?branch=master)]
(https://travis-ci.org/yourusername/yourproject)

yourusernameyourproject替换为你的GitHub用户名和项目名。

5. 许可证

展示项目的许可证类型:

[![License](https://img.shields.io/npm/l/@your/package.svg)]
(https://github.com/yourusername/yourproject/blob/master/LICENSE)

替换相应的用户名、项目名和包名。

6. 代码质量

例如,使用Codecov展示代码覆盖率:

[![codecov](https://codecov.io/gh/yourusername/yourproject/branch/master/graph/badge.svg)]
(https://codecov.io/gh/yourusername/yourproject)

替换yourusernameyourproject

7. 样式检查

例如,使用Stylelint展示样式检查状态:

[![Stylelint](https://img.shields.io/badge/stylelint-enabled-brightgreen.svg)]
(https://stylelint.io/)

徽章服务通常会提供一个简单的标记系统,你只需要替换模板中的占位符为实际的值即可生成徽章。徽章服务的例子包括但不限于:

徽章的URL通常包含了项目的相关信息,如项目名、分支等,以及徽章的显示样式,如颜色、标签等。大多数服务都提供了一个简单的表单或文档,让你可以快速生成所需的徽章链接。