Gerador de distintivos markdown
Crie distintivos shields.io para um README e envolva-os em Markdown, HTML ou reStructuredText.
Gerador de distintivos markdown
Todo o README com um estado de compilação, número de versão ou ícone de licença no topo está a usar um distintivo shields.io — um pequeno SVG cosido a partir de um rótulo, um valor e uma cor. Esta ferramenta constrói esse distintivo para si: preencha o rótulo, valor e cor, escolha um estilo e um logótipo opcional, e ela monta o URL shields.io e envolve-o na marcação que o seu projeto realmente usa.
A opção de estilo cobre todos os cinco estilos shields.io — flat, flat-square, plastic, for-the-badge e social — e o campo logótipo aceita qualquer slug simple-icons (github, npm, docker e centenas mais), tingido com a cor do logótipo quando quer corresponder ao distintivo. Adicione uma ligação e o distintivo torna-se clicável na página renderizada; adicione texto alternativo e permanece significativo para um leitor de ecrã. O formato de saída alterna entre Markdown, HTML e reStructuredText, para que o mesmo distintivo caia directamente num README, num site de documentação ou num projecto Sphinx sem edição manual da marcação.
Construir mais do que um distintivo de cada vez é para o que a segunda caixa serve: cole uma lista, um distintivo por linha como rótulo|valor|cor, e a ferramenta transforma-o numa fileira de distintivos lado a lado — o padrão que vê sob um título do projecto com compilação, cobertura, versão e licença todos numa linha. Ative a ordenação para ordenar essa fileira alfabeticamente, ou adicione uma tabela de distintivos para também renderizar o mesmo conjunto como referência de duas colunas. A opção de escape trata o truque shields.io que aflige as pessoas: um hífen ou espaço literal dentro de um rótulo tem de ser duplicado ou substituído antes do URL ser válido, e esta ferramenta fá-lo automaticamente a menos que o desative.
Tudo funciona no seu navegador. O rótulo, valor e qualquer lista em massa que cole são apenas utilizados para construir uma string URL localmente — nada é carregado, e a ferramenta nunca contacta shields.io, apenas escreve a ligação. Copie o resultado, descarregue-o como um ficheiro .txt, ou envie-o para a entrada de outra ferramenta para continuar a editar.