Gere Markdown de badge para README com texto alternativo

O gerador devolve separadamente o Markdown completo, a URL da imagem e o texto alternativo legível. Ele trata com segurança espaços, hifens, sublinhados, pontuação e colchetes relevantes para Markdown, mantendo a estrutura correta mesmo quando os rótulos descrevem tarefas reais de compilação ou canais de lançamento. Use a ferramenta no navegador para criar um badge rapidamente ou chame a API determinística quando sua documentação for montada de forma automática.

Escolha um texto curto que comunique o status

Um badge útil responde rapidamente a uma pergunta pequena e específica. Coloque a categoria à esquerda como rótulo e o valor atual à direita como mensagem. Por exemplo, um rótulo como compilação acompanhado da mensagem aprovada é mais fácil de reconhecer do que uma frase longa comprimida em uma imagem. O texto alternativo gerado une os dois valores com dois-pontos, oferecendo a quem usa leitor de tela a mesma relação básica transmitida visualmente. Garanta que ambos continuem significativos sem a cor, pois ela nunca deve ser o único meio de apresentar um status essencial. O gerador remove espaços externos, mas preserva a redação e as maiúsculas escolhidas. Rótulos e mensagens vazios são recusados para não criar uma imagem confusa com uma metade em branco. Quando o badge representar automação, prefira termos estáveis entre versões; assim, as diferenças continuam legíveis e as pessoas aprendem onde procurar. O campo alt_text também permite que seu fluxo de documentação verifique ou reutilize a descrição acessível sem desmontar a string final de Markdown.

Entenda como a URL da imagem do Shields é formada

Os badges estáticos do Shields codificam rótulo, mensagem e cor no caminho de uma imagem. Esse caminho possui regras especiais de separação: espaços viram sublinhados, sublinhados literais são duplicados e hifens literais também são duplicados para não serem confundidos com os separadores entre as partes. Os outros sinais recebem codificação percentual para formar uma URL válida. Esta capacidade aplica essas transformações de maneira determinística e devolve a URL resultante junto com o Markdown. Uma cor hexadecimal pode ser enviada com uma cerquilha inicial, que é removida antes de integrar o caminho; nomes de cores do Shields, como brightgreen, podem ser usados diretamente. O serviço não acessa o Shields nem verifica como determinado nome de cor será exibido. Ele apenas gera a referência convencional da imagem, mantendo a execução rápida, privada e adequada a compilações de documentação sem conexão. Como nenhuma chamada de rede acontece, um resultado bem-sucedido confirma a sintaxe produzida, e não o carregamento da imagem remota. Você pode guardar a saída em um modelo e deixar que o leitor final do README solicite a imagem normalmente.

Insira e automatize o Markdown gerado com segurança

Copie o campo markdown para um README, um modelo de pull request, uma página de pacote ou qualquer documento Markdown que aceite imagens remotas. O resultado usa a forma conhecida de imagem, com texto acessível entre colchetes e a URL do Shields entre parênteses. Colchetes e barras invertidas presentes no texto visível são escapados para impedir que conteúdo fornecido pelo usuário encerre antecipadamente a área do texto alternativo. Em um fluxo automatizado, envie os três campos de entrada sempre que renderizar a documentação e grave o valor markdown devolvido no local desejado. Como o algoritmo não usa relógio, aleatoriedade, estado nem rede, entradas idênticas sempre geram saídas idênticas, mantendo os arquivos estáveis no controle de versão. Prefira controlar a posição e a ordem dos badges em seu próprio modelo em vez de montar um README inteiro nesta capacidade. Ela cria deliberadamente um item por solicitação e não edita repositórios, consulta resultados de compilação ou decide qual status exibir. A automação anterior fornece a informação verdadeira; este gerador cuida somente da codificação e da apresentação corretas.