為你的開源專案產生動態Badge(徽章)

底下這個網站挺好玩,可以幫你產生badge(徽章)。

如果你不知道什麼是Badge(徽章),可以先看看成品,類似底下這個頁面上紅框部分的徽章,你可能看過:

在許多open source的開源專案中,你都會看到上面這樣的徽章,大多是在專案的首頁或說明頁面。這些徽章動態的呈現出該開源專案目前的即時狀況,像是當前版本Build成功或失敗、即時下載的數量、程式的最新版本編號資訊…等。

你的開源專案,有這些徽章,看起來就是帥。

當然,它不僅僅只是為了帥氣而已,有這些徽章也可以讓專案的開發人員(參與者)或是程式的使用者對於當前專案的狀況更加一目了然。

要得到這些徽章並不難,例如,當你使用Azure DevOps做自動化的Build Pipeline的時候,Azure Pipeline自動幫你產生這個徽章,可以從pipeline的options中找到:

不過,如果你用其他的工具,可能沒有現成的徽章可以用,例如我開發的是Nuget套件,Nuget目前沒有提供徽章的功能,我就得自己想辦法生出這樣的徽章了。

這時候底下這個小網站就派上用場了,它可以幫你產出各種類型的徽章,支援各大套件庫(例如npm, docker, 當然還有我們的nuget…)
https://shields.io/

你只需要去上面這個網站,找到你要產生的套件類型,然後輸入套件名稱,就會出現相對應的徽章了:

這個網站會提供你該徽章的URL或markdown語法:

你還可以依照自己想要的外觀對徽章長相做選擇或調整。

你把該徽章的markdown語法或是URL貼上你的open source專案說明頁,就是我們前面介紹過的樣子了:

不錯吧,看起來專業多了。

當然,當你nuget套件改版的時候,徽章上的數字會自動更新唷…開源專案就是該這樣,一整個帥。

留言

Pao. Chen Yu寫道…
NuGet的徽章產生器網址在:
https://shields.io/category/version
往下拉到 Nuget 的那行點下去即是。

這個網誌中的熱門文章

在POC或迷你專案中使用 LiteDB

使用 Airtable 在小型需求上取代傳統資料庫

專業的價值...

使用Qdrant向量資料庫實作語意相似度比對

精彩(且驚人)的Semantic Kernel入門範例