Skip to main content

Github README 小图标(ing

1. 图标生成

1.1 模板

Github README 小图标可通过以下链接生成:

https://img.shields.io/badge/-{name}-{bgColor}?style=flat-square&logo={logoName}&logoColor={logoColor}

其中:

  • name:小图标文本
  • bgColor:小图标底色
  • logoName:小图标 Logo 名称,点击查看可用图标
  • logoColor:小图标 Logo 颜色

1.2 示例

示例:

https://img.shields.io/badge/-xxx-7954F6?style=flat-square&logo=4chan&logoColor=FFFFFF

https://img.shields.io/badge/-asd-ED6CEF?style=flat-square&logo=alby&logoColor=FFFFFF

2. 标准化图标

2.1 模板

Github README 中可以将图标与具体链接进行绑定,进行图标生成:

[![Logo description][logo-image]][logo-url]

[logo-image]: http://img.shields.io/{图标对应来源}
[logo-url]: http://{图标点击跳转链接}

其中:

  • Logo description:图标说明
  • logo-image:图标生成地址,http://img.shields.io/ 后面接图标对应来源
  • logo-url:图标点击跳转链接

2.2 示例

2.2.1 license

2.2.1.1 指定 MIT 图标

markdown:

[![license][license-image]][license-url]

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/arco-design/arco-design/blob/main/LICENSE

效果:

license

2.2.1.2 根据项目自适应图标

markdown:

[![license][license-image2]][license-url2]

[license-image2]: https://img.shields.io/github/license/baidubce/bce-qianfan-sdk.svg
[license-url2]: https://github.com/baidubce/bce-qianfan-sdk/blob/master/LICENSE

效果:

license

2.2.2 Github Release

markdown:

[![Release Notes][release-image]][release-url]

[release-image]: https://img.shields.io/github/release/baidubce/bce-qianfan-sdk
[release-url]: https://github.com/baidubce/bce-qianfan-sdk/releases

效果:

Release Notes

2.2.3 codecov(ing

markdown:

[![codecov][codecov-image]][codecov-url]

[codecov-image]: https://img.shields.io/codecov/c/github/ant-design/ant-design/master
[codecov-url]: https://codecov.io/gh/ant-design/ant-design/branch/master

效果:

codecov

2.2.4 npm 版本

markdown:

[![NPM version][npm-image]][npm-url]

[npm-image]: http://img.shields.io/npm/v/antd
[npm-url]: http://npmjs.org/package/antd

效果:

NPM version

2.2.5 npm 下载量

markdown:

[![NPM downloads][download-image]][download-url]

[download-image]: https://img.shields.io/npm/dm/antd
[download-url]: https://npmjs.org/package/antd

效果:

NPM downloads

2.2.7 文档

markdown:

[![docs][docs-image]][docs-url]

[docs-image]: https://img.shields.io/badge/docs-arco-blue?style=flat-square
[docs-url]: https://arco.design

效果:

docs

2.2.8 Feedback Issue

markdown:

[![Feedback Issue][issue-image]][issue-url]

[issue-image]: https://img.shields.io/badge/%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC-GitHub_Issue-brightgreen
[issue-url]: https://github.com/baidubce/bce-qianfan-sdk/issues

效果:

Feedback Issue

2.2.9 Feedback Ticket

markdown:

[![Feedback Ticket][ticket-image]][ticket-url]

[ticket-image]: https://img.shields.io/badge/%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC-%E7%99%BE%E5%BA%A6%E6%99%BA%E8%83%BD%E4%BA%91%E5%B7%A5%E5%8D%95-brightgreen
[ticket-url]: https://console.bce.baidu.com/ticket/#/ticket/create?productId=279

效果:

Feedback Ticket

2.3 示例整合

license Release Notes codecov NPM version NPM downloads docs Feedback Issue Feedback Ticket