最新公告
  • 欢迎您光临起源地模板网,本站秉承服务宗旨 履行“站长”责任,销售只是起点 服务永无止境!立即加入钻石VIP
  • [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    正文概述 掘金(前端周同学)   2021-08-23   842

    这是我参与8月更文挑战的第3天,活动详情查看:8月更文挑战

    前言

    随便打开两个 Github 仓库,你是否会发现很多官方插件仓库都会带有如下图所示的小徽章?再去看看你自己的仓库里,是不是 README.md 文档空空如也,只有干涩的几行文字,今天小周同学就带着你一起继续美化我们的 Github 仓库。

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    更多《玩转 Github》系列文章:

    • [玩转 Github] — 为你的 Github 添加一张与众不同的名片

    生成徽章

    工欲善其事,必先利其器,其实在前端很多事情我们只需要站在巨人的肩膀上即可,生成徽章其实非常的简单,前人已经帮我们做好了很多易用的小公举,今天给大家介绍几个帮助快速生成徽章的网站,记得点赞收藏哦

    • Shields.io 
    • Badgen.net
    • NodeICO

    接下来我就分别用这三个徽章生成器,来给大家简单介绍如何快速方便的生成好看的徽章,然后美化我们的 Github 仓库。

    生成静态徽章

    我们来利用第一个网站 Shields.io ,来给我们的 next-antd-scaffold 仓库增加一个 MIT License 的徽章。

    打开网站之后,我们找到如下图所示的位置,键入三个信息,然后点击生成徽章:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    我这边键入的内容是 license - MIT - blue,最后生成的效果如下:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    可以看到,非常的方便,既然写了,那么就在弄一个 build-passing-green 的徽章一起,接下来把它们放入到仓库 README.md 文档里,效果如下:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    生成动态徽章

    上面介绍了静态徽章的生成以及第一个徽章网站的使用方法,接下来,我们来用第二个网站 Badgen.net 来帮助我们生成一些动态徽章。

    这次选中仓库,dynamic-antd-theme,这是笔者开发的一个小 react 插件,我这边想通过动态的 Badge 来获取最新可用的 release,这边有一个 scheme 如下: https://badgen.net/github/release/:username/:repo/stable,其中 :username = 用户名 :repo = 仓库名,效果如下:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    可以看到,仓库的 release 确实是 0.8.2,确实自动帮我们生成了动态徽章,同样也是把这个 Badge 添加到我们仓库的 READMD.md 文档中,来看看效果:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    生成 NPM 徽章

    介绍完前面两个网站以及徽章的两种用法,接下来我们来介绍第三个网站 NodeICO 以及第三种类型徽章的用法,那就是针对各种 npm 包生成的 npm 徽章,还是不讲那么多废话,我们直接上 Demo 看效果就行,这里以 mini-dynamic-antd-theme 为例,为它生成一个 npm 徽章:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    最后的效果:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    可以看到生效了,不过下面那个 After gip: xxx 有点不好看,既然本文学的就是徽章,那么就来通过自动徽章的形式来生成一下

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    最后的仓库效果:

    [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    总结

    关于生成项目相关的各种徽章,就简单介绍到这里,上面每个网站其实都能做很多事(静态徽章/动态徽章等...),这里只是为了帮助大家了解每一个网站的使用方法,所以拿出一个点来进行了介绍,如果你们感兴趣,可以去每个网站里面看看用用。

    总的来说说大不大说小不小的点,对以后开源写各种插件还是有点帮助,最重要的是如果进行面试当面试官打开你的仓库的时候,可能会有眼前一亮的感觉~


    起源地下载网 » [玩转 Github] — 如何为仓库项目生成漂亮的徽章

    常见问题FAQ

    免费下载或者VIP会员专享资源能否直接商用?
    本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用者承担。更多说明请参考 VIP介绍。
    提示下载完但解压或打开不了?
    最常见的情况是下载不完整: 可对比下载完压缩包的与网盘上的容量,若小于网盘提示的容量则是这个原因。这是浏览器下载的bug,建议用百度网盘软件或迅雷下载。若排除这种情况,可在对应资源底部留言,或 联络我们.。
    找不到素材资源介绍文章里的示例图片?
    对于PPT,KEY,Mockups,APP,网页模版等类型的素材,文章内用于介绍的图片通常并不包含在对应可供下载素材包内。这些相关商业图片需另外购买,且本站不负责(也没有办法)找到出处。 同样地一些字体文件也是这种情况,但部分素材会在素材包内有一份字体下载链接清单。
    模板不会安装或需要功能定制以及二次开发?
    请QQ联系我们

    发表评论

    还没有评论,快来抢沙发吧!

    如需帝国cms功能定制以及二次开发请联系我们

    联系作者

    请选择支付方式

    ×
    迅虎支付宝
    迅虎微信
    支付宝当面付
    余额支付
    ×
    微信扫码支付 0 元