跳至主要內容

GitHub package.json 版本 (分支)

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

路徑參數
user 字串 必要

範例:badges

repo 字串 必要

範例:shields

branch 字串 必要

範例:master

查詢參數
filename 字串

範例:badge-maker/package.json

style 字串

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

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

範例:flat

logo 字串

來自 simple-icons 的圖示 slug。您可以按一下 simple-icons 上的圖示標題來複製 slug,或是在 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> 標籤或標記語言則無效。