Repolode
Enviar
badges

badges/shields

Shields.io é um serviço e uma biblioteca NPM que gera badges de status concisos em SVG e formatos rasterizados para arquivos README e páginas da web.

Ver no GitHubSite
Estrelas
27,368
Forks
5,629
Issues abertas
295
Último commit
há 15 horas

O que é?

Shields.io gera badges consistentes e legíveis que exibem status, versões, downloads, cobertura e métricas semelhantes. Para criar um badge, basta apontar uma URL para uma fonte de dados, como um serviço de CI, um registro de pacotes, uma loja de aplicativos ou uma ferramenta de análise de código; depois, a imagem pode ser incorporada a arquivos README do GitHub ou a qualquer outra página da web. O serviço oferece suporte a dezenas de serviços de integração contínua, registros de pacotes, distribuições, redes sociais e ferramentas de qualidade de código.

Este repositório contém o frontend e o código do servidor do Shields.io, a biblioteca NPM badge-maker para gerar badges programaticamente e a especificação de design dos badges. Os desenvolvedores também podem criar badges personalizados usando uma URL estática que define um rótulo, uma mensagem e uma cor, ou hospedar o servidor por conta própria com integração opcional com Sentry e Prometheus.

O projeto é mantido por uma comunidade de colaboradores e foi desenvolvido com Node.js e Docusaurus para o site de documentação.

Recursos principais

  • 01Gera badges em SVG e formatos rasterizados a partir de uma URL, sem exigir uma conta
  • 02Abrange diversos serviços de CI, registros de pacotes, lojas de aplicativos e ferramentas de análise de código
  • 03Oferece a biblioteca NPM badge-maker para gerar badges no código
  • 04Inclui uma opção de badge estático personalizado, com rótulos e cores à escolha
  • 05Pode ser hospedado por conta própria, com suporte opcional a Sentry e Prometheus

Casos de uso

  • Adicionar badges de build, cobertura e versão a um README do GitHub
  • Exibir contagens de downloads de pacotes ou versões de lançamento na página inicial de um projeto
  • Gerar badges programaticamente em um script de build do Node.js com badge-maker
  • Hospedar um servidor privado de badges para uma organização interna

Início rápido

  1. 1

    Instale o Node 24 usando o gerenciador de pacotes de sua preferência

  2. 2

    Clone este repositório

  3. 3

    Instale as dependências

    npm ci
  4. 4

    Inicie o servidor de badges e o servidor de desenvolvimento do frontend e, em seguida, acesse http://localhost:3000/

    npm start

Antes de usar

  • A configuração do ambiente de desenvolvimento requer o Node 24 e a clonagem do repositório completo.

Tópicos

#badge#svg#status-badge#ci#readme#nodejs#badge-generator#badge-maker#github#hacktoberfest

Perguntas frequentes

O que é shields?
Shields.io é um serviço e uma biblioteca NPM que gera badges de status concisos em SVG e formatos rasterizados para arquivos README e páginas da web. Shields.io gera badges consistentes e legíveis que exibem status, versões, downloads, cobertura e métricas semelhantes. Para criar um badge, basta apontar uma URL para uma fonte de dados, como um serviço de CI, um registro de pacotes, uma loja de aplicativos ou uma ferramenta de análise de código; depois, a imagem pode ser incorporada a arquivos README do GitHub ou a qualquer outra página da web. O serviço oferece suporte a dezenas de serviços de integração contínua, registros de pacotes, distribuições, redes sociais e ferramentas de qualidade de código.
shields é gratuito? Qual é a licença?
shields é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
shields ainda é mantido?
Manutenção ativa. O último commit de shields foi em 7 de nov. de 2026.
Para que posso usar shields?
Adicionar badges de build, cobertura e versão a um README do GitHub Exibir contagens de downloads de pacotes ou versões de lançamento na página inicial de um projeto Gerar badges programaticamente em um script de build do Node.js com badge-maker Hospedar um servidor privado de badges para uma organização interna
Como instalar shields?
Instale o Node 24 usando o gerenciador de pacotes de sua preferência Clone este repositório Instale as dependências: npm ci Inicie o servidor de badges e o servidor de desenvolvimento do frontend e, em seguida, acesse http://localhost:3000/: npm start
Onde consigo shields?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/badges/shields

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados