GitHub 프로필 README 생성기

결과

GitHub 사용자 이름과 동일한 이름의 리포지토리를 만들면, 프로필 페이지 상단에 표시되는 README를 얻을 수 있습니다. 이 생성기는 해당 리포지토리를 위한 깔끔한 Markdown 파일을 만들어 줍니다. 제목, 짧은 소개, 기술 스택, 그리고 github-readme-stats로 실시간 표시되는 선택형 통계 카드가 포함됩니다.

프로필 README 만드는 방법

  1. 1

    정보를 입력하세요

    표시 이름, 태그라인, 위치, 현재 작업 중인 것과 배우고 있는 것을 입력합니다.

  2. 2

    기술 스택을 추가하세요

    쉼표로 구분된 목록으로 입력하면, 각 항목이 굵은 칩 형태로 렌더링됩니다.

  3. 3

    통계 카드를 활성화하세요

    GitHub Stats와 Top Languages 카드는 github-readme-stats에서 실시간으로 렌더링되며, 활동 옵션은 기여 그래프 링크를 추가합니다.

  4. 4

    Markdown을 복사하세요

    사용자 이름과 같은 이름의 리포지토리를 만들고, 루트에 README.md를 푸시하세요.

‘특별한 리포지토리’가 작동하는 원리

사용자 이름이 alex이고 alex라는 이름의 공개 리포지토리를 만들면, GitHub은 해당 리포지토리의 README.md를 프로필(인기 리포지토리 위)에 렌더링합니다. 이는 편법이 아니라 공식 문서에 명시된 기능입니다.

생성기가 삽입할 수 있는 카드

카드 소스 URL 비고
GitHub 통계 github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true 커밋, PR, 이슈
주요 언어 github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... 리포지토리 크기별 언어 분포
기여 활동 github.com/{username}?tab=overview “Streak”를 켜면 표시되는 링크

두 통계 카드는 PNG 엔드포인트라서 누군가 인증 없이 프로필을 열더라도 모든 Markdown 뷰어에서 렌더링됩니다. 활동 링크는 GitHub의 기여 그래프를 엽니다.

잘 읽히는 콘텐츠

  • 한 줄 태그라인: 역할 + 관심 분야(“Rust 인프라 엔지니어, 트레이싱에 관심”).
  • 스택 위에는 최대 3~5개의 글머리 항목만. 그 이상이면 이력서를 나열한 것처럼 보입니다.
  • 문단이 아니라 칩 형태의 스킬로. 독자는 기술을 훑어봅니다.
  • 실제로 관리하는 프로젝트로의 링크. 프로필에 고정한 방치된 리포지토리는 없느니만 못합니다.
  • 연락처 한 줄: 이메일 또는 소셜 계정 하나. 여섯 개의 네트워크를 나열하지 마세요.

여기에 넣지 말아야 할 것

  • 개인 주소나 전화번호.
  • 채용용 문구(“Open to work”는 LinkedIn이나 GitHub의 배너 옵션에 어울립니다).
  • 모든 줄에 이모지, 한두 개는 괜찮지만, 너무 많으면 노이즈입니다.

자주 묻는 질문

github-readme-stats는 Vercel에서 호스팅되며, 때때로 속도 제한이 걸리거나 오래된 데이터가 캐시됩니다. 카드가 깨지면 몇 분 기다리거나 프로젝트를 직접 호스팅하세요. 리포지토리에는 원클릭 Vercel 배포 버튼이 있습니다.

repo 스코프를 가진 토큰으로 서비스를 인증한 경우에만 포함됩니다. 기본적으로 통계는 공개 커밋만 집계하는데, 공개 프로필에서는 보통 그것이 올바른 선택입니다.

네. GitHub은 Markdown 안에서 일부 HTML을 허용합니다, <img>, <details>, <sub>, <sup> 및 간단한 인라인 스타일. 스크립트와 폼은 보안을 위해 제거됩니다.

아니요. 입력한 값은 미리보기를 만들기 위해 서버로 전송되며, 여러 단계 보기에서는 단계 사이에 페이지 링크에 담겨 이동합니다. 데이터베이스에는 아무것도 저장되지 않으며 탭을 닫으면 모두 폐기됩니다.

관련 도구

이 도구는 다른 언어로도 제공됩니다