리드미 ReadMe

Mar 16, 2024


ReadME는 마크 다운 언어. vsCode로 주로 작성

[ 참고한 유튜브 ]


https://www.youtube.com/watch?v=kMEb_BzyUqk
https://www.youtube.com/watch?v=dUbp9wAy178

Heading (제목)


# 을 사용해서 함 

___ (언더스코어) 3번 입력하면 선 추가 됨
Heading 1 아래에는 수평선이 자동으로 추가

텍스트 꾸미기 (bold, italic)

💡

볼드 → ** **

💡

이태릭 → * *

💡

중간 선 → ~~ ~~

인용구, 목록 표시 (대분류, 소분류)


인용구(quote) -> >
목록 표시 방법 -> *, -


숫자를 붙이면 숫자 목록

링크 걸기

💡

[ ] 대괄호 안에 원하는 단어나 문장을 작성한다 ( ) 소괄호 안에 링크를 작성하면 해당 링크로 클릭 가능

이미지 추가하기

방법 1)

💡

느낌표 옆 대괄호에 [ 이미지에 대한 설명을 작성 ] ( ) 소괄호 안에 이미지의 링크를 추가

방법 2)


그냥 리드미 편집 란에다가 이미지 끌어다 넣어라

방법 3)


1. 해당 저장소에 이미지 파일 업로드 하기 -> GitHub  데스크탑 이용 
GitHub 데스크탑 연동...?


커밋 & 푸쉬 (커밋하면 위의 Fetch 부분이 Push로 바뀜)

GIF 올리기, 비디오 업로드하기 (영상은 용량이 작고, MP4 여야 할 것 같음)


ReadMe 편집 버튼 클릭


Issues 우클릭


새 탭에서 링크 열기 클릭


New Issue 초록색 버튼 클릭


원하는 gif나 vedio를 끌어다 놓으면


이런 gif나 vedio 주소가 생성됨. 이걸 복사한 후


ReadMe에다 붙여넣기


그럼 gif와 mp4 영상 모두 잘 나옴!

테이블 (많은 데이터를 효율적으로 표현 가능)


| (작대기)를 쓰고, | (작대기)로 닫으면 -> 한 셀로 완성. 이걸 반복

셀 오른쪽 정렬


:을 오른쪽에 적으면 오른쪽 정렬 (ex. --:)

셀 왼쪽 정렬


:을 왼쪽으로 적으면 왼쪽 정렬 (ex. :--)

셀 중간 정렬


: 을 양쪽으로 붙여준다 (ex. :--:)

문서 안에서 특정한 코드 보여주기 (강조) - 백틱 ( ` )


` (백틱)을 사용하여 인라인 형태로 포맷이 가능

코드 블럭 만들기 (다수의 코드가 있는 경우)


```
```

백틱키 3번

어떤 언어인지 적어주면 문법에 하이라이트가 생긴다


알록달록 해짐! 자바, 자바스크립트, 코틀린 지원 O

체크하기 (체크박스)

이모지 넣기

아래의 이모지 사이트에서 자신이 원하는 이모지를 선택


http://emoji-cheat-sheet.com

배지 만들기


이 badge 모양을 확인하는 사이트 -> License 클릭 
http://shields.io/

배지 커스터마이징


배지 url 복사


이런 식으로... img 넣는 것처럼 src에 기입해주면 됨

인텔리 J 에서 README 수정


이거 누르기

💡

문단을 구별하려면 줄의 마지막에 [ 스페이스바를 2번 ] 눌러 띄어쓰기 할 것! 혹은 <br>

See more posts