【工具系列】为你的项目制作 Shields 徽章

2022-11-30 16:27:45 浏览数 (1)

前言

在 GitHub 许多开源项目都有很漂亮的徽章,它们可以用来显示项目的进度,访问人数,版本信息以及 GitHub stars 数量等等,比如 kjs-common 这个项目

自定义徽章

shields 徽章可用来说明项目状态或者版本等信息,可以访问官网 https://www.shields.io/ 制作徽章,

找到 Your BADGE 自定义定制徽章,输入标签和信息,点击生成:

效果

在 markdown 可以使用 html 语法显示图标

代码语言:javascript复制
<a href="https://tencent.cos.mobaijun.com/img/icon/avatar.jpg"><img src="https://img.shields.io/badge/框架师-墨白-green" alt="博客"></a>

也可以直接编辑 URL:

代码语言:javascript复制
https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>.svg
# 或者
https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

参数设置

有以下几种颜色可以选择:

brightgreen、green、yellow、green、yellow、orange、red、blue、lightgrey、success、important、critical、informational、inactive、blueviolet、ff69b4、9cf


还可以配置 style 和 logo 参数

代码语言:javascript复制
https://img.shields.io/badge/框架师-墨白-green?style=social&logo=github

style 样式默认为 flat,还可以设置为 plastic、flat-square、for-the-badge 和 social。 logo 可以选择 Simple Icons:https://simpleicons.org 上提供的图标,比如微信的图标:

代码语言:javascript复制
logo=WeChat

其他

更多玩法可到 https://shields.io/ 查阅。

  • 设置链接

可以给徽章设置一个链接

代码语言:javascript复制
[![](https://img.shields.io/badge/框架师-墨白-green?style=social&logo=github)](https://www.mobaijun.com)

或者使用 HTML 语法:

代码语言:javascript复制
<p align="center">
<a href="https://www.mobaijun.com"><img src="https://img.shields.io/badge/框架师-墨白-green?style=social&logo=github" alt=""></a>
</p>

0 人点赞