跳至主要內容

GitHub commit 狀態

顯示由 Commit Status API 回報的 tag、commit 或分支狀態。現今,GitHub Actions 和許多第三方整合透過 Checks API 回報狀態。如果此徽章沒有顯示預期的值,請試用我們對應的檢查執行徽章。您可以在 GitHub 文件中閱讀更多關於狀態檢查的資訊。

如果您的 GitHub 徽章錯誤,可能是因為您達到 GitHub 的速率限制。您可以透過使用您的 GitHub 帳戶新增 Shields GitHub 應用程式來增加 Shields.io 的速率限制。

路徑參數
user 字串 必要

範例:badges

repo 字串 必要

範例:shields

commit 字串 必要

範例:91b108d4b7359b2f8794a4614c11cb1157dc9fff

查詢參數
style 字串

可能的值:[flat, flat-square, plastic, for-the-badge, social]

如果未指定,則此徽章的預設樣式為「flat」。

範例:flat

logo 字串

來自 simple-icons 的圖示代稱。您可以在 simple-icons 上點擊圖示標題以複製代稱,或者可以在 simple-icons 儲存庫中的 slugs.md 檔案中找到它們。更多資訊

範例:appveyor

logoColor 字串

圖示的顏色(支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色)。支援 simple-icons 圖示,但不支援自訂圖示。

範例:violet

logoSize 字串

透過設定 auto 使圖示自動調整大小。對於某些較寬的圖示(例如 amdamg)很有用。支援 simple-icons 圖示,但不支援自訂圖示。

範例:auto

label 字串

覆寫預設的左側文字(空格或特殊字元需要URL 編碼!)

範例:healthiness

labelColor 字串

左側部分的背景顏色(支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色)。

範例:abcdef

color 字串

右側部分的背景顏色(支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色)。

範例:fedcba

cacheSeconds 字串

HTTP 快取存留時間(會套用規則以根據每個徽章推斷預設值,任何指定低於預設值的值都將被忽略)。

範例:3600

link 字串[]

指定點擊徽章的左側/右側應該執行什麼動作。請注意,這僅在您將徽章整合到 <object> HTML 標籤中時才有效,但對於 <img> 標籤或標記語言無效。