Gerador de Distintivos README
Digite um rótulo, uma mensagem e uma cor e este gerador cria um distintivo estático do shields.io: a pequena pílula plana que você vê sob o título de um README (build | passing, license | MIT, version | 1.4.0). Ele mostra uma pré-visualização ao vivo e fornece tanto o Markdown quanto o HTML para colar. Shields.io é o serviço de distintivos padrão para projetos de código aberto; o formato da URL é simples, mas trabalhoso de memorizar, então uma pequena interface gráfica economiza alguns minutos ao configurar um novo repositório.
Como criar um distintivo
-
1
Escreva o rótulo e a mensagem
O rótulo é a metade esquerda (cinza); a mensagem é a metade direita. Escreva o que você quer que a pílula mostre: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.
-
2
Escolha uma cor
Uma cor nomeada (brightgreen, blue, red, orange) ou um código hexadecimal como `#ff0000`. Ela preenche a metade direita do distintivo.
-
3
Estilize-o
Escolha um estilo (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) e, opcionalmente, um logo pelo seu slug do simple-icons (github, npm, docker).
-
4
Copie o Markdown ou o HTML
Cole no seu README. Adicione a URL de link opcional para tornar o distintivo clicável. Shields.io renderiza o SVG sob demanda.
Receitas comuns de distintivos
Esta ferramenta cria a forma estática badge/label-message-color. Para distintivos que mostram dados ao vivo (status de construção, versão, downloads), copie um dos padrões de URL do shields.io abaixo e cole diretamente no seu README.
| Propósito | Padrão de URL do Shields.io |
|---|---|
| versão npm | https://img.shields.io/npm/v/{package} |
| downloads npm | https://img.shields.io/npm/dm/{package} |
| estrelas GitHub | https://img.shields.io/github/stars/{owner}/{repo} |
| último commit GitHub | https://img.shields.io/github/last-commit/{owner}/{repo} |
| status do workflow GitHub | https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml} |
| Licença | https://img.shields.io/github/license/{owner}/{repo} |
| versão PyPI | https://img.shields.io/pypi/v/{package} |
| pulls Docker | https://img.shields.io/docker/pulls/{org}/{image} |
| cobertura Codecov | https://img.shields.io/codecov/c/github/{owner}/{repo} |
| rótulo estático | https://img.shields.io/badge/{label}-{message}-{color} |
Comparação de estilo de distintivos
- flat, retângulos arredondados clássicos. Padrão.
- flat-square, cantos afiados, um pouco mais moderno.
- for-the-badge, letras em bloco em maiúsculas, máxima atenção.
- plastic, gradiente e sombra interna, estilo retrô.
- social, cantos arredondados e atenuados, combina com os próprios botões de estrela/fork do GitHub.
Quando usar distintivos
- Construção + cobertura, informa aos visitantes que o projeto está realmente mantido.
- Versão + downloads, informa que está em uso.
- Licença, sinal legal para quem considera contribuir ou usar.
- Link para docs, site de docs externo ou rustdoc.rs.
- Chat / suporte, link do Discord, Matrix, GitHub Discussions.
Quando não usar distintivos
- Estatísticas de vaidade que nunca atualizam. Um distintivo de “estrelas” para um repositório com 0 estrelas faz o projeto parecer morto.
- Cada métrica possível. Cinco distintivos contam uma história; quinze não contam nada.
- Informações duplicadas. Licença + “MIT” duas vezes, ou versão mostrada tanto como um distintivo quanto na primeira linha do texto.
- Distintivos para serviços que você não usa. Não adicione Codecov se você não tiver relatórios de cobertura configurados, o distintivo quebrado é pior do que nenhum distintivo.
Cache e confiabilidade
Shields.io armazena em cache as solicitações de forma agressiva. Um distintivo que atualiza lentamente geralmente só precisa de um cache bust (anexar ?v=2) ou alguns minutos. Se shields.io estiver fora do ar, o GitHub renderiza “shields” sem gráfico, vale a pena mencionar, mas se recupera rapidamente.
Perguntas frequentes
Não. Shields.io é gratuito e financiado por doações. Usuários de alto volume são convidados a auto-hospedar ou apoiar o projeto.
Sim. Shields é de código aberto; você pode executá-lo atrás do seu próprio domínio. A maioria dos projetos não precisa, o serviço gratuito é confiável.
Cache. Anexe ?cacheSeconds=60 ou ?v=anything para forçar uma atualização. Espere até alguns minutos de propagação.
Sim, adicione ?logo=github (ou qualquer slug de simple-icons). Use ?logoColor=white para ajustar a cor do ícone.
Não. Tudo roda no navegador e as URLs são geradas do lado do cliente para cópia.
Ferramentas relacionadas
Referência da Tabela ASCII
Tabela ASCII completa de 0 a 127 com valores decimais, hexadecimais, octais e binários e notação de referência numérica HTML, incluindo NUL, LF e DEL.
Referência de Caracteres HTML
Lista pesquisável de entidades HTML, seus códigos nomeados e numéricos, e uma cópia com um clique para caracteres e símbolos especiais.
Referência de atalhos de teclado
Pesquise atalhos padrão documentados do VS Code, Chrome e Bash com GNU Readline no macOS, Windows e Linux.
Conversor de Tamanho de Arquivo
Converta entre bytes, KB, MB, GB, TB e as unidades binárias IEC (KiB, MiB, GiB, TiB), combinando decimal e binário como preferir.
Validador de Email
Valide um endereço de email: verificação de sintaxe RFC 5322, consulta de registro MX em tempo real, além de detalhes de parte local, domínio e comprimento. Nenhum email é enviado.
Gerador de EditorConfig
Monte um .editorconfig com as suas regras de indentação, fim de linha e charset e acrescente a seção correta para cada linguagem do seu repositório: Python, Go, YAML, Makefile e mais.
Ferramenta disponível em outros idiomas
- مولد شارات README [AR]
- Générateur de badge README [FR]
- README 배지 생성기 [KO]
- Generator Badge README [ID]
- README-Badge-Generator [DE]
- Generator odznak README [PL]
- README-badgegenerator [NL]
- README-badgegenerator [SV]
- เครื่องสร้างแบดจ์ README [TH]
- READMEバッジジェネレーター [JA]
- Bộ tạo huy hiệu README [VI]
- Generador de Insignias README [ES]
- README Rozet Üreteci [TR]
- README 徽章生成器 [ZH]
- README Badge Generator [EN]
- Generatore di Badge README [IT]
- Генератор бейджей README [RU]