制作GitHub README 徽章

作为一名技术人员,会经常接触GitHub, 每当看到别人的项目README制作的很漂亮的时候,就会立马想到此项目高大上,逼格很高。其实,这个制作也很简单,今天就给大家介绍一下。


文章目录

  • 制作GitHub README 徽章
  • 引言
  • 徽章
  • 制作方法
    • shields.io 网站
      • 1. 集成接口生成徽章
      • 2. 自定义生成徽章
  • 总结


引言

开始之前,先给自己的GitHub项目打个广告 。AndroidBF 是一个基于AndroidX,能够简化android开发,封装集成了部分主流开源框架,采用MVP架构和material design方式的基础项目。 希望大家多多支持,欢迎大家fork and star.


徽章

今天就以AndroidBF 项目的徽章作为一个例子讲解,请看下图:


README 中这几个徽章,分别是 CSDN 博客链接, AndroidBF demo apk下载链接,license 链接, release 发布链接,最后commit的时间,项目top language, 仓库大小。

制作方法

shields.io 网站

1. 集成接口生成徽章

shields.io 网站集成了很多仓库和工具的接口,可以读取状态,生成徽章,比如Github,Maven, Jenkins,npm等,下图是license接口徽章。


我们可以根据提供的接口,按照接口参数要求填写自己的账号,仓库等信息,即可生成。比如我的license,

copy 徽章连接到你的README 中即可展示License徽章。

2. 自定义生成徽章

我的需求我做主,我就要定制个性化徽章,那就用自定义方式。


如图所示,填入label, message, color 即可生成。比如生成CSDN MarkSDGD 徽章,如下图:


总结

徽章制作很简单,好的徽章会让你的项目更加出彩。

更多推荐

制作GitHub README 徽章