Generator README profilu GitHub

Wyniki

Utworzenie repozytorium o nazwie zgodnej z Twoją nazwą użytkownika GitHub daje Ci plik README, który pojawia się na górze strony profilu. Ten generator tworzy schludny plik Markdown dla tego repozytorium: nagłówek, krótki opis, stos technologiczny oraz opcjonalne karty statystyk zasilane przez github-readme-stats.

Jak zbudować README profilu

  1. 1

    Uzupełnij swoje dane

    Nazwa wyświetlana, hasło przewodnie, lokalizacja oraz to, nad czym pracujesz i czego się uczysz.

  2. 2

    Dodaj swój stos technologiczny

    Lista rozdzielona przecinkami; każdy element wyświetlany jest jako pogrubiony żeton.

  3. 3

    Włącz karty statystyk

    Karty GitHub Stats i Top Languages renderują się na żywo z github-readme-stats; opcja aktywności dodaje link do wykresu kontrybucji.

  4. 4

    Skopiuj Markdown

    Utwórz repozytorium o nazwie takiej samej jak Twoja nazwa użytkownika i wypchnij README.md do katalogu głównego.

Jak działa „specjalne repozytorium“

Jeśli Twoja nazwa użytkownika to alex i utworzysz publiczne repozytorium o nazwie alex, GitHub wyświetli plik README.md tego repozytorium na Twoim profilu (nad sekcją „Popularne repozytoria“). To udokumentowana funkcja, a nie sztuczka.

Karty, które generator może osadzić

Karta Adres URL źródła Uwagi
Statystyki GitHub github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true Commity, PR-y, issues
Główne języki github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... Podział języków według rozmiaru repozytorium
Aktywność kontrybucji github.com/{username}?tab=overview Link widoczny po włączeniu opcji “Streak”

Obie karty statystyk to punkty końcowe w formacie PNG, renderują się w dowolnej przeglądarce Markdown, również gdy ktoś otworzy Twój profil bez zalogowania; link aktywności otwiera wykres kontrybucji na GitHubie.

Treść, która dobrze się czyta

  • Hasło przewodnie w jednej linijce: rola + specjalizacja („Inżynier infrastruktury Rust, zainteresowany trasowaniem“).
  • Maksymalnie 3–5 punktów nad stosem technologicznym; więcej i całość wygląda jak zrzut CV.
  • Umiejętności w formie żetonów, a nie akapitu. Czytelnicy skanują wzrokiem w poszukiwaniu technologii.
  • Linki do projektów, które faktycznie utrzymujesz. Porzucone repozytoria przypięte na profilu są gorsze niż ich brak.
  • Wiersz kontaktowy: e-mail lub jedno konto w mediach społecznościowych; unikaj wymieniania sześciu sieci.

Czego tam nie umieszczać

  • Prywatnych adresów lub numerów telefonu.
  • Tekstu dla rekruterów („Open to work“ pasuje do LinkedIn lub opcji banera GitHub).
  • Emoji w każdej linijce, jedno lub dwa są w porządku, dżungla to szum.

Najczęściej zadawane pytania

github-readme-stats jest hostowany na Vercel i sporadycznie ogranicza liczbę zapytań lub buforuje nieaktualne dane. Jeśli karta się zepsuje, poczekaj kilka minut albo hostuj projekt samodzielnie, repozytorium ma przycisk wdrożenia na Vercel jednym kliknięciem.

Tylko jeśli uwierzytelnisz usługę tokenem o zakresie repo. Domyślnie statystyki liczą wyłącznie publiczne commity, co zwykle jest właściwym wyborem na profilu publicznym.

Tak. GitHub dopuszcza podzbiór HTML w Markdown, <img>, <details>, <sub>, <sup> oraz proste style inline. Skrypty i formularze są usuwane ze względów bezpieczeństwa.

Nie. Wartości, które wpisujesz, są wysyłane do naszego serwera, aby zbudować podgląd, a w widoku wieloetapowym są przenoszone w linku strony między krokami. Nic nie jest zapisywane w bazie danych i wszystko jest odrzucane po zamknięciu karty.

Powiązane narzędzia

Narzędzie jest dostępne w innych językach