Github 徽章整理
相信很多在Github上玩耍过的同学们都会发现,在很多项目的README里会有各式各样的徽章,是不是顿时感觉到很高上大?没关系,读完这篇文章你就也可以拥有这些徽章了,甚至可以定制自己的徽章。
NodeJs
如果这是一个用npm管理的一个包,请添加:
[版本图片](https://www.npmjs.com/package/项目名)
如果你使用了第三方的组件,那可以标识是否为最新版本。
TypeScript
如果你是TypeScript开发者,那么请把下面的这些徽章用起来吧:
[![TypeScript](https://badges.frapsoft.com/typescript/love/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)
[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)
[![TypeScript](https://badges.frapsoft.com/typescript/awesome/typescript.png?v=101)](https://github.com/ellerbrock/typescript-badges/)
[![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-v18.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)
还有更多的格式与尺寸详见这里。
awesome
如果你是awesome系列的项目,那可以添加awesome徽章:
[图片](https://github.com/sindresorhus/awesome)
Google Analytics
Google Analytics是通过嵌入图像追踪项目访问量的一种方法。
如我的DogFood项目就内嵌了一个追踪图像:
具体制作过程可以参考。
Gitter
这是对issue功能的一个补充。正常情况下,当你给某个项目提出问题时,需要新建一个issue提出,并且需要等待开发者的回复(短则一两天,长则大半年),效率不是很高。而Gitter就提供了一个实时的聊天室,项目的开发者可以用github账号登陆之,为某个项目创建一个聊天室,然后再项目的Readme中加入如下代码:
[![Gitter](https://badges.gitter.im/Join Chat.svg)](聊天室 URL)
就可以显示聊天室的徽章啦:
[
单击即可进入聊天室,与开发者进行实时沟通。
Code Related
有很多的在线测试平台都提供测试状态标识,你可以把他们放到相应项目中的README中:
- Travis Ci
- Codecov
- Code Climate
- bithound
Version Stability
[![deprecated](http://badges.github.io/stability-badges/dist/deprecated.svg)](http://github.com/badges/stability-badges)
[![experimental](http://badges.github.io/stability-badges/dist/experimental.svg)](http://github.com/badges/stability-badges)
[![unstable](http://badges.github.io/stability-badges/dist/unstable.svg)](http://github.com/badges/stability-badges)
[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)
[![frozen](http://badges.github.io/stability-badges/dist/frozen.svg)](http://github.com/badges/stability-badges)
[![locked](http://badges.github.io/stability-badges/dist/locked.svg)](http://github.com/badges/stability-badges)
更多请看这里。
Open Source
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badge/)
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badge/)
[![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badge/)
还有更多的徽章格式与尺寸详见这里。
Licences
Software
开源软件协议的种类非常多,具体可以参考阮一峰的如何选择开源许可证?,本文列举了MIT和GPL:
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://opensource.org/licenses/GPL-3.0/)
还有更多的徽章格式与尺寸详见这里。
Creative Commons
知识共享是一系列著作权许可方式,我们可以在官网选择自己的许可协议。如我采用了知识共享署名-相同方式共享:
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Others
Github上有一个badges的仓库,里面收集了一些常用的,大家可以参考一下。
Your Badges
如果你需要自己定制一个徽章的话,可以参考这里。
About me
- Weibo:@AnSwEr不是答案
- GitHub:AnSwErYWJ
- Blog:AnSwEr不是答案的专栏
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
本作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可。