Shieldsio

---
name: shieldsio
description: Use this skill when building, customizing, or debugging Shields.io badge URLs, working with dynamic JSON/TOML/XML/YAML badges, choosing logo and style parameters, or checking self-hosting and upgrade notes.
version: 1.0.0
source: https://shields.io/
license: MIT
---

# Shields.io

Use this skill when you need to:
- build or edit Shields.io badge URLs
- choose common badge parameters such as style, label, colors, logos, cache lifetime, and click targets
- work with dynamic JSON, TOML, XML, or YAML badges
- check integration-specific notes for GitHub, Gitea, Sonar, Open Collective, or self-hosted Shields
- look up upgrade, security, or compatibility changes such as Simple Icons updates and the Dynamic JSON/TOML/YAML advisory

## Start Here

- `references/getting-started.md` for the product surface and where to begin
- `references/core-patterns.md` for recurring badge parameters and common URL patterns
- `references/api-reference.md` for dynamic badge inputs and static badge docs

## Reference Files

- `references/getting-started.md` for intro, builder workflow, and product entry points
- `references/core-patterns.md` for shared badge parameters, logos, filters, and common caveats
- `references/api-reference.md` for Dynamic JSON, TOML, XML, and YAML badge inputs plus static badge docs
- `references/testing-debugging.md` for troubleshooting selectors, compatibility issues, and service caveats
- `references/integrations-plugins.md` for GitHub OAuth, self-hosted services, Badge-Maker, Docker, and related integrations
- `references/upgrades.md` for security advisories, migration notes, and Simple Icons changes
- `references/badges.md` for the full extracted badge catalog

## Retrieval Tips

- Start with the compact references above before opening `references/badges.md`.
- Use `references/badges.md` when you need service-specific path parameters or examples for a particular badge.