跳至主要內容

Sonar 程式碼文件化 API 密度

Sonar 徽章可與 SonarCloud.io 和自託管的 SonarQube 實例一起使用。只需輸入您的目標 Sonar 部署的正確協定和路徑即可。

如果您以版本 5.3 或更早的舊版 SonarQube 實例為目標,請務必包含版本查詢參數,並使用您的 SonarQube 版本的值。

路徑參數
component 字串 必要

範例:swellaby:letra

查詢參數
server 字串 必要

範例:https://sonarcloud.io

sonarVersion 字串

範例:4.2

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> 標籤或標記語言。