GitHub 프로필 README 꾸미기 정리

GitHub 프로필 README 꾸미기

GitHub 구경하기

 

 

 

1. Repository 생성하기

 

먼저 GitHub 프로필을 만들기 위서는 Repository를 생성해야 합니다.

 

Repositories 에서 New 버튼을 클릭해서 Repository 생성 창으로 이동합니다.

 

 

Create a new Repository 화면에서

Owner와 같은 이름으로 Repository name을 적어줍니다.

저는 이미 있기 때문에 존재한다고 경고 메세지가 나오고 있네요.

 

이후 Add a README file 을 체크해주고

Create repository 버튼을 눌러 Repository를 생성합니다.

 

 

생성하게 되면 오른쪽에 special repository라고 나오며

Edit README 버튼이 있습니다. 이 버튼을 누르거나 연필모양을 누르면

README 파일을 수정할 수 있습니다.

 

 

2. Header 꾸미기

https://github.com/kyechan99/capsule-render

GitHub - kyechan99/capsule-render: 🌈 Dynamic Coloful Image Render

 

위 사이트에서 Header를 원하는 대로 꾸밀 수 있습니다. 한글 버전도 있기 때문에 설정은 어렵지 않습니다.

 

![header](https://capsule-render.vercel.app/api?type=venom&color=auto&height=300&section=header&text=%20HeeYeong's-GitHub&fontSize=90)

 

제가 설정한 값은 위와 같습니다.

 

 

3. 뱃지 이용하기

https://github.com/Envoy-VC/awesome-badges

GitHub - Envoy-VC/awesome-badges: 😎 A curated list of GitHub badges for your next project

 

위 사이트에서 원하는 뱃지의 URL 복사 붙여넣기로 내가 사용하는 언어나 툴을 나타낼 수 있습니다.

 

 

저 같은 경우에는 위 처럼 사용했던 언어들과 툴을 표시했습니다.

뱃지 모양이나 내용도 수정 가능하니 원하시는 뱃지 스타일로 사용하시면 될 것 같습니다.

 

![Blogger](https://img.shields.io/badge/Blog-FF5722?style=flat&logo=Tistory&logoColor=white)
![Oracle](https://img.shields.io/badge/Oracle%20sql-F80000?style=for-the-badge&logo=oracle&logoColor=white)

 

blog는 style을 flat으로 진행했고, 언어는 for-the-badge로 진행했습니다.

오라클 같은 경우는 ORACLE SQL로 나타내기 위해 Oracle%20sql로 변경했습니다.

뱃지에서 띄어쓰기는 %20으로 표현할 수 있습니다.

 

 

4. 방문자 수 표시하기

https://hits.seeyoufarm.com/

HITS

 

방문자 수는 위 사이트에서 꾸밀 수 있습니다.

 

 

Target url에 본인 깃 허브 주소를 입력하면 

Options에 hits가 생성되고

아이콘을 추가하거나 title을 변경할 수 있으며

색상도 변경할 수 있습니다.

 

제 컴퓨터가 조금 안 좋은지 이 Htis 사이트만 접속하면 렉이 심해서

만드는데 시간이 조금 오래 걸렸습니다.

 

 

 

5. GitHub Stats 보여주기

https://github.com/anuraghazra/github-readme-stats

GitHub - anuraghazra/github-readme-stats: :zap: Dynamically generated stats for your github readmes

 

위 사이트에서 만들 수 있으며 친절하게 한국어도 지원해 어렵지 않게 만들 수 있습니다.

username=깃허브아이디로 변경해주시면 됩니다.

 

 

 

저는 주로 다크모드를 사용하기 때문에 GitHub Stats도 검은색인 것을 골라서 설정했습니다.

 

 

6. 3D 잔디밭 (레고 잔디밭) 심기

 

https://github.com/yoshi389111/github-profile-3d-contrib#step-4-add-image-to-readmemd

GitHub - yoshi389111/github-profile-3d-contrib: This GitHub Action creates a GitHub contribution calendar on a 3D profile image.

 

3D 잔디밭은 위 사이트에서 설정 가능합니다.

아쉽게도 한국어 설명은 없습니다. 그래도 구글링 하면 이미 설정하고 계신 분들이 많으니 금방 하실 수 있습니다.

 

먼저 Github 토큰을 생성해야 합니다.

기존에 GitHub토큰이 있으신 분들은 그대로 사용하시면 됩니다.

 

토큰을 생성해야 하시는 분들은

 

 

먼저 Settings 를 누르고 제일 밑에 Developer settings를 눌러줍니다.

 

 

 

Personal access tokens 메뉴에 Tokens를 클릭합니다.

 

 

 

Generate new token 버튼을 누르고 classic을 눌러줍니다.

 

 

Note에는 어디에 쓸 토큰인지 이름을 지어주시면 됩니다.

Expiration은 no expiration으로 설정해주시고,

Select scopes에 있는 체크 박스들을 체크해주시면 됩니다.

저는 전부 체크를 해줬습니다.

 

이후 Generate Token 버튼을 눌러 토큰을 생성해주세요

토큰을 생성하셨으면 토큰 값을 잃어버리지 않게 안전한 곳에 복사 붙여넣기 해주세요.

 

 

이후

본인 Repository로 이동후 Settings로 이동합니다.

 

 

 

Secrets and variables에 Actions를 누른 뒤에 new repository secret 버튼을 클릭합니다.

Name에는 TOKEN이라고 적어주고

Secret에는 아까 생성한 토큰의 값을 붙여넣기 해줍니다.

 

 

이후에 다시 본인 Repository로 이동 후 Actions로 이동합니다.

 

 

 

 

Actions 옆에 New workflow 버튼을 누르고,

set up a workflow yourself 버튼을 클릭합니다.

 

아까 소개해드린 사이트에 올라와 있는 코드를 붙여넣기 하시면 됩니다.

 

name: GitHub-Profile-3D-Contrib

on:
  schedule: # 03:00 JST == 18:00 UTC
    - cron: "0 18 * * *"
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: generate-github-profile-3d-contrib
    steps:
      - uses: actions/checkout@v3
      - uses: yoshi389111/github-profile-3d-contrib@0.7.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          USERNAME: ${{ github.repository_owner }}
      - name: Commit & Push
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
          git add -A .
          git commit -m "generated"
          git push

 

 

secrets.GITHUB_TOKEN 이라고 되어 있는 부분을 secrets.TOKEN 으로 수정해주세요.

user.name 뒤에 값 github-actions는 본인 깃허브에 사용한 이름,

user.email 뒤에 값 github-acounts@githun.com 은 깃허브 등록할 때 이메일로 바꿔주시면 됩니다.

 

이후 actions 화면에서 Run workflow 버튼을 클릭하시면 됩니다.

 

 

정상적으로 동작했다면 화면에 위 처럼 표시 됩니다.

 

이제 리드미에 잔디밭이 들어갈 위치에 해당 코드들 중에 하나를 붙어넣어주시면 됩니다.

레고는 제일 마지막 코드입니다.

 

profile-3d-contrib/profile-green-animate.svg
profile-3d-contrib/profile-green.svg
profile-3d-contrib/profile-season-animate.svg
profile-3d-contrib/profile-season.svg
profile-3d-contrib/profile-south-season-animate.svg
profile-3d-contrib/profile-south-season.svg
profile-3d-contrib/profile-night-view.svg
profile-3d-contrib/profile-night-green.svg
profile-3d-contrib/profile-night-rainbow.svg
profile-3d-contrib/profile-gitblock.svg

 

 

https://github.com/HeeYeong91

HeeYeong91 - Overview

 

 

 

혹시 안되시는게 있으시다면 댓글 달아주시면 저도 원인을 같이 한번 찾아보겠습니다.