[玩轉 Github] — 如何為倉庫專案生成漂亮的徽章

前端周同學發表於2021-08-23

這是我參與8月更文挑戰的第3天,活動詳情檢視:8月更文挑戰

前言

本文大約花費你5分鐘,結合更多的玩轉 Github 系列,可以讓你的 Github 看起來與眾不同,更具吸引力。

隨便開啟兩個 Github 倉庫,你是否會發現很多官方外掛倉庫都會帶有如下圖所示的小徽章?再去看看你自己的倉庫裡,是不是 README.md 文件空空如也,只有乾澀的幾行文字,今天小周同學就帶著你一起繼續美化我們的 Github 倉庫。

image.png

image.png

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

生成徽章

工欲善其事,必先利其器,其實在前端很多事情我們只需要站在巨人的肩膀上即可,生成徽章其實非常的簡單,前人已經幫我們做好了很多易用的小公舉,今天給大家介紹幾個幫助快速生成徽章的網站,記得點贊收藏哦

接下來我就分別用這三個徽章生成器,來給大家簡單介紹如何快速方便的生成好看的徽章,然後美化我們的 Github 倉庫。

生成靜態徽章

我們來利用第一個網站 Shields.io ,來給我們的 next-antd-scaffold 倉庫增加一個 MIT License 的徽章。

開啟網站之後,我們找到如下圖所示的位置,鍵入三個資訊,然後點選生成徽章:

image.png

我這邊鍵入的內容是 license - MIT - blue,最後生成的效果如下:

image.png

可以看到,非常的方便,既然寫了,那麼就在弄一個 build-passing-green 的徽章一起,接下來把它們放入到倉庫 README.md 文件裡,效果如下:

image.png

生成動態徽章

上面介紹了靜態徽章的生成以及第一個徽章網站的使用方法,接下來,我們來用第二個網站 Badgen.net 來幫助我們生成一些動態徽章。

這次選中倉庫,dynamic-antd-theme,這是筆者開發的一個小 react 外掛,我這邊想通過動態的 Badge 來獲取最新可用的 release,這邊有一個 scheme 如下: https://badgen.net/github/release/:username/:repo/stable,其中 :username = 使用者名稱 :repo = 倉庫名,效果如下:

image.png

image.png

可以看到,倉庫的 release 確實是 0.8.2,確實自動幫我們生成了動態徽章,同樣也是把這個 Badge 新增到我們倉庫的 READMD.md 文件中,來看看效果:

image.png

生成 NPM 徽章

介紹完前面兩個網站以及徽章的兩種用法,接下來我們來介紹第三個網站 NodeICO 以及第三種型別徽章的用法,那就是針對各種 npm 包生成的 npm 徽章,還是不講那麼多廢話,我們直接上 Demo 看效果就行,這裡以 mini-dynamic-antd-theme 為例,為它生成一個 npm 徽章:

image.png

最後的效果:

image.png

可以看到生效了,不過下面那個 After gip: xxx 有點不好看,既然本文學的就是徽章,那麼就來通過自動徽章的形式來生成一下

image.png

最後的倉庫效果:

image.png

實話實說,npm 倉庫徽章有點醜不協調?,不過也就這樣了,只是為了給大家演示一下方法而已~

總結

關於生成專案相關的各種徽章,就簡單介紹到這裡,上面每個網站其實都能做很多事(靜態徽章/動態徽章等...),這裡只是為了幫助大家瞭解每一個網站的使用方法,所以拿出一個點來進行了介紹,如果你們感興趣,可以去每個網站裡面看看用用。

總的來說說大不大說小不小的點,對以後開源寫各種外掛還是有點幫助,最重要的是如果進行面試當面試官開啟你的倉庫的時候,可能會有眼前一亮的感覺~

相關文章