GitHub-profiel-README-generator

Resultaten

Een repository maken waarvan de naam overeenkomt met je GitHub-gebruikersnaam levert je een README op die bovenaan je profielpagina verschijnt. Deze generator maakt een net Markdown-bestand voor die repository: kop, korte bio, tech stack en optionele statistiekkaarten aangedreven door github-readme-stats.

Hoe je de profiel-README opbouwt

  1. 1

    Vul je gegevens in

    Weergavenaam, slogan, locatie, waar je aan werkt en wat je leert.

  2. 2

    Voeg je tech stack toe

    Een door komma's gescheiden lijst; elk item wordt weergegeven als een vetgedrukte chip.

  3. 3

    Schakel statistiekkaarten in

    De kaarten GitHub Stats en Top Languages worden live weergegeven vanuit github-readme-stats; de activiteitsoptie voegt een link naar je bijdragegrafiek toe.

  4. 4

    Kopieer de Markdown

    Maak een repository met je gebruikersnaam als naam en push de README.md naar de root.

Hoe de ‘speciale repo’ werkt

Als je gebruikersnaam alex is en je maakt een openbare repository met de naam alex, dan geeft GitHub de README.md van die repository weer op je profiel (boven ‘Populaire repositories’). Dit is een gedocumenteerde functie, geen hack.

Kaarten die de generator kan insluiten

Kaart Bron-URL Opmerkingen
GitHub-statistieken github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true Commits, PR’s, issues
Belangrijkste talen github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... Taalverdeling naar repogrootte
Bijdrageactiviteit github.com/{username}?tab=overview Link die verschijnt als “Streak” is ingeschakeld

De twee statistiekkaarten zijn PNG-endpoints en worden weergegeven in elke Markdown-viewer, ook wanneer iemand je profiel zonder authenticatie opent; de activiteitslink opent je bijdragegrafiek op GitHub.

Inhoud die prettig leest

  • Slogan van één regel: rol + focus (‘Rust-infra-engineer, geïnteresseerd in tracing’).
  • Maximaal 3–5 opsommingstekens boven de stack; meer en het leest als een uitgestort cv.
  • Vaardigheden als chips, geen alinea. Lezers scannen op techniek.
  • Links naar projecten die je daadwerkelijk onderhoudt. Verlaten repo’s die op je profiel zijn vastgepind, zijn erger dan helemaal geen.
  • Contactregel: e-mail of één sociale account; vermijd het opsommen van zes netwerken.

Wat je er niet in moet zetten

  • Privéadressen of telefoonnummers.
  • Recruiterteksten (‘Open to work’ hoort thuis op LinkedIn of bij de banneroptie van GitHub).
  • Emoji’s op elke regel, één of twee is prima, een jungle is ruis.

Veelgestelde vragen

github-readme-stats wordt gehost op Vercel en legt af en toe een rate limit op of cachet verouderde gegevens. Als een kaart het niet doet, wacht dan een paar minuten of host het project zelf, de repository heeft een deployknop voor Vercel met één klik.

Alleen als je de dienst authenticeert met een token dat de repo-scope heeft. Standaard tellen de statistieken alleen openbare commits, wat meestal de juiste keuze is voor een openbaar profiel.

Ja. GitHub staat een subset van HTML toe in Markdown, <img>, <details>, <sub>, <sup> en eenvoudige inline-stijlen. Scripts en formulieren worden om veiligheidsredenen verwijderd.

Nee. De waarden die je typt, worden naar onze server gestuurd om de preview op te bouwen en worden in de meerstappenweergave tussen de stappen via de paginalink meegestuurd. Er wordt niets in een database opgeslagen en alles wordt verwijderd zodra je het tabblad sluit.

Gerelateerde tools

Tool beschikbaar in andere talen