跳至主要內容

GitHub 分支狀態

顯示標籤、提交或分支的狀態,如同 Commit Status API 所回報。現在,GitHub Actions 和許多第三方整合透過 Checks API 回報狀態。如果此徽章未顯示預期的值,請嘗試使用我們對應的「檢查執行」徽章。您可以在 GitHub 文件中閱讀更多關於狀態檢查的資訊。

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

路徑參數
user 字串 必填

範例:badges

repo 字串 必填

範例:shields

branch 字串 必填

範例:master

查詢參數
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 字串

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

範例:healthiness

labelColor 字串

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

範例:abcdef

color 字串

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

範例:fedcba

cacheSeconds 字串

HTTP 快取生命週期(會套用規則以根據每個徽章推斷預設值,任何低於預設值的值都將被忽略)。

範例:3600

link 字串[]

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