Generatore di Badge README

Markdown
Risultati

Scrivi un’etichetta, un messaggio e un colore e questo generatore crea un badge statico shields.io: la piccola pillola piatta che vedi sotto il titolo di un README (build | passing, license | MIT, version | 1.4.0). Mostra un’anteprima dal vivo e ti fornisce sia il Markdown sia l’HTML da incollare. Shields.io è il servizio di badge de facto per i progetti open-source; il formato dell’URL è semplice ma scomodo da memorizzare, quindi una piccola interfaccia grafica ti fa risparmiare qualche minuto quando configuri un nuovo repo.

Come creare un badge

  1. 1

    Scrivi l'etichetta e il messaggio

    L'etichetta è la metà sinistra (grigia); il messaggio è la metà destra. Scrivi ciò che vuoi che la pillola mostri: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Scegli un colore

    Un colore con nome (brightgreen, blue, red, orange) o un codice esadecimale come `#ff0000`. Riempie la metà destra del badge.

  3. 3

    Stilizzalo

    Scegli uno stile (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) e, facoltativamente, un logo tramite il suo slug di simple-icons (github, npm, docker).

  4. 4

    Copia il Markdown o l'HTML

    Incollalo nel tuo README. Aggiungi l'URL del link opzionale per rendere il badge cliccabile. Shields.io genera l'SVG su richiesta.

Ricette comuni per badge

Questo strumento crea la forma statica badge/label-message-color. Per i badge che mostrano dati dal vivo (stato di build, versione, download), copia uno dei modelli di URL shields.io qui sotto e incollalo direttamente nel tuo README.

Scopo Modello URL Shields.io
versione npm https://img.shields.io/npm/v/{package}
download npm https://img.shields.io/npm/dm/{package}
stelle GitHub https://img.shields.io/github/stars/{owner}/{repo}
ultimo commit GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
stato workflow GitHub https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Licenza https://img.shields.io/github/license/{owner}/{repo}
versione PyPI https://img.shields.io/pypi/v/{package}
download Docker https://img.shields.io/docker/pulls/{org}/{image}
copertura Codecov https://img.shields.io/codecov/c/github/{owner}/{repo}
etichetta statica https://img.shields.io/badge/{label}-{message}-{color}

Confronto degli stili dei badge

  • flat, rettangoli arrotondati classici. Predefinito.
  • flat-square, angoli netti, leggermente più moderni.
  • for-the-badge, lettere maiuscole in blocco, massima attenzione.
  • plastic, sfumatura e ombra interna, old-school.
  • social, angoli arrotondati e colori smorzati, corrisponde ai pulsanti stella/fork di GitHub.

Quando usare i badge

  • Build + copertura, informa i visitatori che il progetto è effettivamente mantenuto.
  • Versione + download, comunica che è in uso.
  • Licenza, segnale legale per chiunque stia considerando di contribuire o utilizzare.
  • Link alla documentazione, sito di documentazione esterna o rustdoc.rs.
  • Chat / supporto, link a Discord, Matrix, GitHub Discussions.

Quando non usare i badge

  • Statistiche di vanità che non si aggiornano. Un badge “stelle” per un repo con 0 stelle fa sembrare il progetto morto.
  • Ogni possibile metrica. Cinque badge raccontano una storia; quindici non dicono nulla.
  • Informazioni duplicate. Licenza + “MIT” due volte, o versione mostrata sia come badge che nella prima riga di prosa.
  • Badge per servizi che non usi. Non aggiungere Codecov se non hai impostato la segnalazione della copertura, il badge rotto è peggio di nessun badge.

Caching e affidabilità

Shields.io memorizza aggressivamente le richieste. Un badge che si aggiorna lentamente di solito ha solo bisogno di un’azione di cache (aggiungi ?v=2) o di alcuni minuti. Se shields.io è inattivo, GitHub genera “shields” senza grafica, vale la pena menzionarlo, ma si riprende rapidamente.

Domande frequenti

No. Shields.io è gratuito e finanziato da donazioni. Gli utenti ad alto volume sono invitati a ospitare autonomamente o supportare il progetto.

Sì. Shields è open source; puoi eseguirlo dietro il tuo dominio. La maggior parte dei progetti non ha bisogno di farlo, il servizio gratuito è affidabile.

Caching. Aggiungi ?cacheSeconds=60 o ?v=anything per forzare un aggiornamento. Aspettati fino a pochi minuti di propagazione.

Sì, aggiungi ?logo=github (o qualsiasi slug di simple-icons). Usa ?logoColor=white per modificare il colore dell’icona.

No. Tutto viene eseguito nel browser e gli URL sono generati lato client per la copia.

Strumenti correlati

Strumento disponibile in altre lingue