GitHub-profil-README-generator

Resultat

Att skapa ett repository vars namn matchar ditt GitHub-användarnamn ger dig en README som visas högst upp på din profilsida. Den här generatorn producerar en ren Markdown-fil för det repot: rubrik, kort bio, teknikstack och valfria statistikkort drivna av github-readme-stats.

Så bygger du profil-README:n

  1. 1

    Fyll i dina uppgifter

    Visningsnamn, slogan, plats, vad du arbetar med och lär dig.

  2. 2

    Lägg till din teknikstack

    Kommaseparerad lista; varje objekt renderas som en fet chip.

  3. 3

    Aktivera statistikkort

    Korten GitHub Stats och Top Languages renderas live från github-readme-stats; aktivitetsalternativet lägger till en länk till din bidragsgraf.

  4. 4

    Kopiera Markdown

    Skapa ett repo uppkallat efter ditt användarnamn och pusha README.md i roten.

Hur det “speciella repot” fungerar

Om ditt användarnamn är alex och du skapar ett publikt repo som heter alex, renderar GitHub README.md i det repot på din profil (ovanför Populära repositorier). Det är en dokumenterad funktion, inte ett hack.

Kort som generatorn kan bädda in

Kort Käll-URL Anmärkningar
GitHub-statistik github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true Commits, PR:er, issues
Främsta språk github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... Språkfördelning efter repostorlek
Bidragsaktivitet github.com/{username}?tab=overview Länk som visas när “Streak” är på

De två statistikkorten är PNG-endpoints och renderas i vilken Markdown-visare som helst, inklusive när någon laddar din profil oautentiserad; aktivitetslänken öppnar din bidragsgraf på GitHub.

Innehåll som läses väl

  • Enradsslogan: roll + fokus (“Rust-infrastrukturingenjör, intresserad av tracing”).
  • 3–5 punkter max ovanför stacken; fler och det läses som en CV-tömning.
  • Färdigheter som chips, inte ett stycke. Läsare skannar efter teknik.
  • Länkar till projekt du faktiskt underhåller. Övergivna repon fästa på profilen är värre än inga.
  • Kontaktrad: e-post eller ett enda socialt handtag; undvik att lista sex nätverk.

Vad du inte ska lägga där

  • Privata adresser eller telefonnummer.
  • Rekryterartext (“Open to work” hör hemma i LinkedIn eller GitHubs banneralternativ).
  • Emoji på varje rad, en eller två går bra, en djungel är brus.

Vanliga frågor

github-readme-stats hostas på Vercel och hastighetsbegränsar eller cachar ibland inaktuell data. Om ett kort går sönder, vänta några minuter eller self-hosta projektet, repot har en Vercel-deploy-knapp med ett klick.

Bara om du autentiserar tjänsten med en token som har repo-scope. Som standard räknar statistiken endast publika commits, vilket vanligtvis är rätt val på en publik profil.

Ja. GitHub tillåter en delmängd av HTML i Markdown, <img>, <details>, <sub>, <sup> och vanliga inline-stilar. Skript och formulär tas bort av säkerhetsskäl.

Nej. De värden du skriver skickas till vår server för att bygga förhandsvisningen, och i flerstegsvyn förs de vidare i sidlänken mellan stegen. Ingenting lagras i en databas och allt kastas när du stänger fliken.

Relaterade verktyg

Verktyget finns på andra språk