Genera imágenes de vista previa para compartir repositorios de GitHub, con estadísticas en tiempo real, logotipos, fuentes y patrones de fondo.
badges/shields
Shields.io es un servicio y una biblioteca NPM que genera badges de estado concisos en SVG y formato rasterizado para archivos README y páginas web.
- Estrellas
- 27,364
- Forks
- 5,630
- Issues abiertos
- 295
- Último commit
- hace 19 horas
¿Qué es?
Shields.io genera badges coherentes y fáciles de leer que muestran el estado, las versiones, las descargas, la cobertura y otras métricas similares. Para crear un badge, basta con dirigir una URL a una fuente de datos, como un servicio de CI, un registro de paquetes, una tienda de aplicaciones o una herramienta de análisis de código; luego, la imagen se puede insertar en archivos README de GitHub o en cualquier otra página web. El servicio es compatible con decenas de servicios de integración continua, registros de paquetes, distribuciones, redes sociales y herramientas de calidad de código.
Este repositorio contiene el frontend y el código del servidor de Shields.io, la biblioteca NPM badge-maker para generar badges mediante código y la especificación de diseño de los badges. También se pueden crear badges personalizados con una URL estática que defina una etiqueta, un mensaje y un color, o alojar el servidor por cuenta propia con integración opcional con Sentry y Prometheus.
El proyecto lo mantiene una comunidad de colaboradores y está desarrollado con Node.js; su sitio de documentación usa Docusaurus.
Funciones clave
- 01Genera badges SVG y rasterizados a partir de una URL, sin necesidad de una cuenta
- 02Es compatible con numerosos servicios de CI, registros de paquetes, tiendas de aplicaciones y herramientas de análisis de código
- 03Ofrece la biblioteca NPM badge-maker para generar badges mediante código
- 04Incluye una opción para crear badges estáticos personalizados con etiquetas y colores arbitrarios
- 05Se puede alojar por cuenta propia con compatibilidad opcional con Sentry y Prometheus
Casos de uso
- Añadir badges de compilación, cobertura y versión a un README de GitHub
- Mostrar el número de descargas de un paquete o las versiones publicadas en la página principal de un proyecto
- Generar badges mediante código en un script de compilación de Node.js con badge-maker
- Alojar un servidor de badges privado para una organización interna
Inicio rápido
- 1
Instala Node 24 con el gestor de paquetes que prefieras
- 2
Clona este repositorio
- 3
Instala las dependencias
npm ci - 4
Inicia el servidor de insignias y el servidor de desarrollo del frontend; después, abre http://localhost:3000/
npm start
Antes de usarlo
- La configuración del entorno de desarrollo requiere Node 24 y clonar el repositorio completo.
Temas
Preguntas frecuentes
- ¿Qué es shields?
- Shields.io es un servicio y una biblioteca NPM que genera badges de estado concisos en SVG y formato rasterizado para archivos README y páginas web. Shields.io genera badges coherentes y fáciles de leer que muestran el estado, las versiones, las descargas, la cobertura y otras métricas similares. Para crear un badge, basta con dirigir una URL a una fuente de datos, como un servicio de CI, un registro de paquetes, una tienda de aplicaciones o una herramienta de análisis de código; luego, la imagen se puede insertar en archivos README de GitHub o en cualquier otra página web. El servicio es compatible con decenas de servicios de integración continua, registros de paquetes, distribuciones, redes sociales y herramientas de calidad de código.
- ¿shields es gratuito? ¿Qué licencia tiene?
- shields es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿shields sigue mantenido?
- Mantenimiento activo. El último commit de shields fue el 6 nov 2026.
- ¿Para qué puedo usar shields?
- Añadir badges de compilación, cobertura y versión a un README de GitHub Mostrar el número de descargas de un paquete o las versiones publicadas en la página principal de un proyecto Generar badges mediante código en un script de compilación de Node.js con badge-maker Alojar un servidor de badges privado para una organización interna
- ¿Cómo se instala shields?
- Instala Node 24 con el gestor de paquetes que prefieras Clona este repositorio Instala las dependencias: npm ci Inicia el servidor de insignias y el servidor de desarrollo del frontend; después, abre http://localhost:3000/: npm start
- ¿Dónde consigo shields?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/badges/shields
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Servicio gratuito alojado que muestra el contador de visitas de un perfil de GitHub como una imagen para insertar en el README del perfil.
Referencia de sintaxis Markdown y archivo de prueba que muestra cómo se renderiza GitHub Flavored Markdown (GFM) en README, issues y wikis.
Convierte el gráfico de contribuciones de GitHub en un GIF o WebP animado de un juego espacial al estilo de Galaga, listo para insertar en tu perfil.
Una GitHub Action que genera estadísticas de programación de WakaTime y las muestra como texto o gráficos SVG en el README de tu perfil de GitHub.
CLI de Go que ejecuta cualquier linter o herramienta de análisis de código y publica sus resultados como comentarios de revisión en GitHub, GitLab o Bitbucket, solo en las líneas modificadas.