Skip to main content

Sonar Documented API Density

The Sonar badges will work with both SonarCloud.io and self-hosted SonarQube instances. Just enter the correct protocol and path for your target Sonar deployment.

If you are targeting a legacy SonarQube instance that is version 5.3 or earlier, then be sure to include the version query parameter with the value of your SonarQube version.

Path Parameters
component string REQUIRED

Example: swellaby:letra

Query Parameters
server string REQUIRED

Example: https://sonarcloud.io

sonarVersion string

Example: 4.2

style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

Если не указано, стиль по умолчанию для этого значка будет "flat".

Example: flat

logo string

Иконка из simple-icons. Вы можете щелкнуть по названию иконки на simple-icons, чтобы скопировать slug, или они могут быть найдены в файле slugs.md в репозитории simple-icons. Дополнительная информация.

Example: appveyor

logoColor string

Цвет логотипа (hex, rgb, rgba, hsl, hsla и css-названия цветов поддерживаются). Поддерживается для логотипов simple-icons, но не для кастомных логотипов.

Example: violet

logoSize string

Настройте адаптивный размер иконок, установив значение auto. Это полезно для более широких логотипов, таких как amd и amg. Поддерживается для логотипов simple-icons, но не для кастомных логотипов.

Example: auto

label string

Переопределите текст на левой части значка (URL-encoded для пробелов или специальных символов!).

Example: healthiness

labelColor string

Цвет фона левой части (поддерживаются hex, rgb, rgba, hsl, hsla и css-названия цветов).

Example: abcdef

color string

Цвет фона правой части (поддерживаются hex, rgb, rgba, hsl, hsla и css-названия цветов).

Example: fedcba

cacheSeconds string

Время жизни HTTP-кэша (правила применяются для вычисления значения по умолчанию для каждого значка, любые указанные значения, ниже значения по умолчанию, будут игнорироваться).

Example: 3600

link string[]

Укажите, что должно происходить при клике на левую/правую часть значка. Обратите внимание, что это работает только при интеграции значка в тег HTML <object>, но не в тег <img> или разметку.