README-badgegenerator

Markdown
Resultaten

Typ een label, een bericht en een kleur, en deze generator maakt een statische shields.io-badge: dat platte kleine pilletje dat je onder een README-titel ziet (build | passing, license | MIT, version | 1.4.0). Hij toont een live voorbeeld en geeft je zowel de Markdown als de HTML om te plakken. Shields.io is de de-factostandaard voor badges van opensourceprojecten; het URL-formaat is eenvoudig maar lastig te onthouden, dus een kleine grafische interface bespaart je een paar minuten wanneer je een nieuwe repository opzet.

Hoe maak je een badge

  1. 1

    Typ het label en het bericht

    Het label is de linkerhelft (grijs); het bericht is de rechterhelft. Typ wat de badge moet tonen: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Kies een kleur

    Een benoemde kleur (brightgreen, blue, red, orange) of een hexcode zoals `#ff0000`. Die vult de rechterhelft van de badge.

  3. 3

    Geef het stijl

    Kies een stijl (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) en eventueel een logo via de simple-icons-slug (github, npm, docker).

  4. 4

    Kopieer de Markdown of HTML

    Plak het in je README. Voeg de optionele link-URL toe om de badge klikbaar te maken. Shields.io rendert de SVG op verzoek.

Veelvoorkomende badge-recepten

Deze tool maakt de statische vorm badge/label-message-color. Voor badges met live gegevens (buildstatus, versie, downloads) kopieer je een van de shields.io-URL-patronen hieronder en plak je het rechtstreeks in je README.

Doel shields.io-URL-patroon
npm-versie https://img.shields.io/npm/v/{package}
npm-downloads https://img.shields.io/npm/dm/{package}
GitHub-sterren https://img.shields.io/github/stars/{owner}/{repo}
Laatste commit op GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
Status van de GitHub-workflow https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Licentie https://img.shields.io/github/license/{owner}/{repo}
PyPI-versie https://img.shields.io/pypi/v/{package}
Docker-pulls https://img.shields.io/docker/pulls/{org}/{image}
Codecov-dekking https://img.shields.io/codecov/c/github/{owner}/{repo}
Statisch label https://img.shields.io/badge/{label}-{message}-{color}

Vergelijking van badge-stijlen

  • flat, klassieke afgeronde rechthoeken. Standaard.
  • flat-square, scherpe hoeken, iets moderner.
  • for-the-badge, blokletters in hoofdletters, maximale aandacht.
  • plastic, gradiënt en ingevoegde schaduw, ouderwets.
  • social, ronde hoeken en gedempte kleuren, passend bij GitHubs eigen ster-/fork-knoppen.

Wanneer je badges moet gebruiken

  • Build + dekking, laat bezoekers zien dat het project echt wordt onderhouden.
  • Versie + downloads, laat zien dat het wordt gebruikt.
  • Licentie, een juridisch signaal voor iedereen die overweegt bij te dragen of het te gebruiken.
  • Documentatielink, externe documentatiesite of rustdoc.rs.
  • Chat / ondersteuning, link naar Discord, Matrix of GitHub Discussions.

Wanneer je geen badges moet gebruiken

  • IJdelheidsstatistieken die nooit worden bijgewerkt. Een “sterren”-badge voor een repository met 0 sterren laat het project dood lijken.
  • Elke mogelijke metriek. Vijf badges vertellen een verhaal; vijftien zeggen niets.
  • Dubbele informatie. Licentie + “MIT” twee keer, of de versie zowel als badge als in de eerste regel tekst.
  • Badges voor diensten die je niet gebruikt. Voeg Codecov niet toe als je geen dekkingsrapportage hebt ingesteld; een kapotte badge is erger dan geen badge.

Caching en betrouwbaarheid

Shields.io cachet verzoeken agressief. Een badge die langzaam bijwerkt, heeft meestal alleen een cache-reset nodig (voeg ?v=2 toe) of een paar minuten. Als shields.io uitvalt, toont GitHub het woord “shields” zonder afbeelding; het vermelden waard, maar het herstelt snel.

Veelgestelde vragen

Nee. Shields.io is gratis en wordt met donaties gefinancierd. Gebruikers met een zeer hoog volume wordt gevraagd de dienst zelf te hosten of het project te steunen.

Ja. Shields is opensource; je kunt het onder je eigen domein draaien. De meeste projecten hoeven dat niet: de gratis dienst is betrouwbaar.

Caching. Voeg ?cacheSeconds=60 of ?v=anything toe om een verversing af te dwingen. Reken op enkele minuten voor de verspreiding.

Ja, voeg ?logo=github toe (of een willekeurige simple-icons-slug). Gebruik ?logoColor=white om de kleur van het pictogram aan te passen.

Nee. Alles draait in de browser en de URL’s worden aan de clientkant gegenereerd om te kopiëren.

Gerelateerde tools

Tool beschikbaar in andere talen