GitHub - README 활용(마크다운, 글꼴, 목록, 체크박스, 구분선, 이미지, 인용글, 코드블럭)

# README? 리드미란?

해당 리포지토리(프로젝트)의 설명을 나타내는 파일을 뜻합니다.

배포를 목적으로 만든 리포지토리일 경우라면, 다른 사람들이 해당 리포지토리를 보고 어떤 것인지 알 수 있어야 하므로 배포시 가능한한(거의 무조건) 작성하는 것이 좋습니다.

---

마크다운(Markdown) 사용하기

• 헤더와 서브헤더는 구분선이 존재

# (h1) : 가장 큰 헤더
## (h2) : h1보다 좀 더 작은 서브 헤더
### (h3) : h2보다 좀 더 작은 텍스트
#### (h4) : h3보다 좀 더 작은 텍스트
##### (h5) : h4보다 좀 더 작은 텍스트
###### (h6) : h5보다 좀 더 작은 텍스트

---

굵게/기울임꼴/취소선 사용하기

• 적용할 단어 앞 뒤에 기호 기입

*기울임꼴* or _기울임꼴_
**굵게** or __굵게__
~~취소선~~

---

목록 만들기

• 들여쓰기를 사용하면 세부 목록 생성
• 맨 앞에 더하기(+), 빼기(-), 별표(*)를 사용하여 목록 생성 가능

- 목록1
   - 목록1-1

---

체크박스 만들기

• 미들바(-)와 중괄호([])를 사용하여 체크박스 생성
  • 중괄호 사이에 공백이 올 경우 : 체크박스 해제
  • 중괄호 사이에 영문자 'x'를 넣을 경우 : 체크박스 선택

- [ ] 체크박스 해제
- [x] 체크박스 선택

---

구분선 만들기

미들바(-), 언더바(_), 별표(*)를 세개씩 입력

---
___
***

---

이미지 삽입하기

• 텍스트는 이미지가 보이지 않을 경우 출력, 혹은 작성시 작성자의 구분을 도울 수 있음

![텍스트](이미지 링크 주소)

 

+ 이미지 삽입 쉽게 하는 방법 (Issues 이용)

• 자신의 리파지토리 아래의 'Issues' 클릭

 

• 'New issue' 클릭

 

• 이미지 파일 업로드(드래그) -> 코드 복사 -> 'Submit new issue' 클릭

 

• 리드미 작성시 복사해두었던 코드 붙여넣기 

 

---

인용글 넣기

• > 를 사용하여 인용글 영역 생성

인용1
> 인용2
> > 인용3
> > > 인용4

---

코드 블럭 사용하기

• ` (물결 버튼, 키보드 숫자 1 왼쪽에 존재) 앞 뒤로 세 번 입력
• 그 사이에는 들여쓰기로 코드를 작성
• 첫번째 ``` 오른쪽에는 사용하는 언어를 입력하면 그에 맞는 가독성 제공

``` 사용 언어
	import numpy as np
```