README 徽章產生器

輸入 GitHub repo,一次產生 CI 狀態、授權、Stars、npm 版本與下載量等 README 徽章的 Markdown。

瀏覽器端執行:輸入與輸出不會傳送到伺服器,平台也不會保存你的輸入內容。

輸入

內容不會被保存

輸出

填入左側欄位後按下執行。

使用方法

  1. 1輸入 repo(owner/repo 或網址都可以)。
  2. 2勾選要顯示的徽章並選擇樣式。
  3. 3複製 Markdown 貼到 README.md 的標題下方。

常見問題

徽章顯示 repo not found?

shields.io 只能讀取公開 repo。私有 repo 的 CI 狀態可以改用 GitHub 內建的 workflow badge(需登入才看得到)。

CI 徽章一直顯示 no status?

workflow 至少要執行過一次,且檔名要和 .github/workflows 裡的檔案一致。

徽章會即時更新嗎?

會,但 shields.io 與 GitHub 的圖片快取可能讓變化延遲幾分鐘出現。

我的輸入會上傳嗎?

不會。Markdown 在瀏覽器產生;徽章圖片則是之後由看 README 的人的瀏覽器向 shields.io 讀取。