github 徽章从何而来

什么是徽章

徽章是一种小巧精美的小图标,一般配有相关文字进行辅助说明,富有表现力.

不仅出现于 github 项目主页,凡是能够表现图片的地方都可以出现徽章,本质上是一种 svg 格式的矢量图标.

下面以自定义 github-adsryen-brightgreen.svg 徽章为例,简单认识一下徽章.

  • 在线链接

在线链接: github-adsryen-brightgreen.svg

https://img.shields.io/badge/github-adsryen-brightgreen.svg
  • 浏览器效果

打开在线链接,并检查当前网页,豁然开朗,徽章是一种 svg 实现的矢量图标.

badge-inspect-github-adsryen-brightgreen.png
  • svg VS png

如果说 svg 是矢量图形而 png 却不是,所以不妨将 png 姑且称之为标量图形.

svg 是矢量图形,png 是标量图形,两者均能实现类似效果,只不过矢量图形不论怎么方法都能保持原样,并不会像 png 那样会失真而已.

既然两种均能表现相同的效果,现在我们就来演示一下 png 的实现效果.

badge-github-adsryen-brightgreen.png

svgpng 在线网站: https://cloudconvert.com/svg-to-svg

badge-github-adsryen-svg-png.png

左侧的 svg 无论放大多少倍,依然保持原样,清晰度保持不变.右侧的 png 一旦放大,立马变得模糊不清.

如何使用徽章

大多数徽章都是 svg 格式,当然也不排除某些徽章是 png 格式,不论怎么说,一律当成图标使用就可以了.

如果你和我一样,希望在 markdown 文件中使用徽章,那么建议使用在线链接,或者引入本地 svg 相关文件.

徽章格式 : [![图片文字说明](图片源地址)](超链接地址) 即超链接内部嵌套图片

github

如果你是在 html 文件使用徽章,同样先取得在线徽章地址,然后按照 html 语法插入图片即可.

徽章格式 : <a href="超链接地址"><img src="图片源地址" alt="图片文字说明"></a> 即超链接内部嵌套图片

github

不论是什么语法,最核心最根本的获得到徽章链接,至于不同语言有着各自的语法,按照语言规则手动拼接就好.

  • Badge URL

  • Markdown

  • HTML

  • Textile

  • RDOC

  • AsciiDoc

  • RST

徽章分类

如果以徽章的格式为标准,那么可以分为svgpng 两类.

  • svg

gitbook-plugin-mygitalk.svg
  • png

gitbook-plugin-mygitalk.png

如果以徽章的样式为标准,那么可以分为默认样式和自定义样式两类.

  • 默认样式

GitHub stars
  • 自定义样式

Ryen

如果以徽章的内容数据是否动态为标准,那么可以分为静态数据和动态数据两类.

静态数据意味着数据本身是不变的,只要在线链接不变,那么生成的徽章永远不会改变,而动态数据意味着生成徽章的数据是动态变化的,即使在线链接不变,当数据本身发现变化时,徽章自然随之更新.

  • 静态数据

github-adsryen-brightgreen.svg
  • 动态数据

gitbook-plugin-mygitalk.svg

静态数据示例中 github-adsryen-brightgreen.svg 数据不会更改,自然生成的徽章也不会变.动态数据示例中 gitbook-plugin-mygitalk.svgnpm 的版本号,当项目升级后,版本号会发生更改,那么生成的徽章也会随之更新.

如果以徽章的内容数据来源为标准,那么可以有无数多的分类.

  • GitHub

gitbook-plugin-mygitalk
  • Npm

gitbook-plugin-mygitalk
  • Docker

centos

如果以徽章的内容数据用途为标准,那么也可以有无数多的分类.

  • 构建状态

Travis (.org)
  • 代码覆盖率

Codecov
  • 代码分析

GitHub top language

徽章来源

徽章有不同的分类,不管是哪种分类,在线徽章最为简单便捷,下面就简单介绍下提供在线生成徽章的网站.

https://shields.io/

适用于绝大多数情况,默认按照徽章内容分类,Build,Code Coverage,Analysis 等多主题,同时支持自定义徽章和动态徽章.

如果徽章的主题明确,那么根据网站提供的主题对号入座即可在线生成徽章,下面以 gitbook-plugin-mygitalk 为例,简要说明如何获得相应徽章链接.

gitbook-plugin-mygitalkgitbook 的一款评论插件.

badge-shields.io-theme.png

打开网站后按照分类,选择其中一个主题,点击进去后填写目标信息,即可在线生成徽章.

  • 浏览已支持的主体,选择 License 许可证主题.

badge-shields.io-theme-license.png
  • 浏览已支持的 License 许可证列表,选择 NPM 许可证.

badge-shields.io-theme-license-npm.png
  • 填写好正确的 npm 包信息并实时预览,然后点击按钮复制徽章链接或者或者特定格式的徽章.

NPM

按照主题生成徽章真的很简单,首先对号入座,然后按需生成相应徽章即可,唯一的要求就是对号入座!

如果默认提供的徽章主题没有适合自己的徽章,或者想要自定义徽章效果,那么也可以在线制作私人订制徽章.

  • 打开网站后往下拉,找到 Your Badge 区域,准备制作专属徽章.

badge-shields.io-custom.png
  • 填写(Label)标签-(Message)信息-(Color)颜色等信息后,点击(Make Badge)生成徽章.

badge-shields.io-custom-make.png
  • 点击生成徽章后默认会在当前标签页面打开该链接,手动复制链接并调整成目标格式即可.

badge-shields.io-custom-make-preview.png
微信公众号-Ryen-brightgreen.svg

https://badgen.net/

徽章内容来源种类较多,默认按照平台分类,按照特定规则生成徽章,需要手动拼接在线链接,略显繁琐.

badge-badgen.net.png

虽然支持颜色,图标以及查询参数等高级用法,但是还是习惯性采用默认设置,下面动手开始制作徽章吧!

  • 切换到默认动态徽章选项卡,选择 GitHUb 徽章.

badge-badgen.net-live-github.png
  • 选择 stars 徽章,将 micromatch 替换成目标信息.

/github/stars/micromatch/micromatch 替换成 /stars/adsryen/gitbook.prlrr.com

  • 预览徽章效果并手动修改成目标格式.

badge-badgen.net-live-github-adsryen.png
gitbook.prlrr.com

除了支持动态徽章,同样也支持静态徽章,切换到 STATIC BADGES 选项卡,一起来生成静态徽章吧!

badge-badgen.net-static.png
★★★★☆

按照徽章的在线链接规则,应该也支持自定义徽章,再次回顾一下链接规则:

规则 : https://badgen.net/badge/:subject/:status/:color ,如果是自定义动态链接,估计不支持吧!

微信公众号-Ryen

https://forthebadge.com/

扁平化的徽章,支持的徽章数量有限,不支持自定义徽章.

badge-orthebadge.com.png

网站首页默认提供了一些预览徽章,左侧是复制 image 链接,右侧是复制 markdown 链接.

forthebadge

网站首页默认展示的徽章毕竟有限,如果找不到理想徽章,岂不是白介绍了这个网站,当然不能够!

VIEW ALL 查看目前支持的全部徽章,如果还是找不到徽章,那就真的没有.

badge-orthebadge.com-all.png

https://badge.fury.io/

版本徽章,支持各类平台版本,包括 npm ,Ruby,Python,Go 等平台.

badge-badge.fury.io.png

选择目标平台并输入包管理信息,即可在线生成各个类型的徽章版本.

badge-badge.fury.io-npm.png

npm version

排版布局

默认 markdown 实现的图片是依次排开的,无法自定义样式,而 markdown 语法同时也兼容 html 语法,因此我们可以用 html 语法实现居中对齐.

Build Status Coverage Status Downloads License License

抛砖引玉

  • 社交化徽章

GitHub followers
GitHub forks
GitHub stars
GitHub watchers
  • 自定义徽章

github wechat 慕课网 简书 csdn 博客园 掘金 思否 开源中国 腾讯云社区

  • 进度条徽章

progress progress completed done

参考文档

在线网站

最后更新于

这有帮助吗?