README.md가 초라할 때, MarkDown 문법 정석 작성법!

안녕하세요!!

오늘은 깃허브의 꽃, README 작성법에 대해 알아보려고 합니다.

깃허브를 처음 시작하시는 분들이라면 모두 README 작성에 대해 난감할 때가 많습니다.

이 글을 참고하시면 여러분들도 README를 가독성이 좋게 꾸미실 수 있을 거예요!

 

우선, README를 간단하게 설명드리자면

README란?

리드미(README, readme, read me) 파일은 디렉터리나 압축 파일에 포함된 기타 파일에 대한 정보를 포함하고 있으며, 일반적으로 컴퓨터 소프트웨어와 함께 배포된다. 

즉, 한마디로 요약하자면 해당 소프트웨어에 대한 정보를 기입해놓은 문서 파일로 생각하시면 되겠네요!!

이 README.md는 MarkDown의 문법에 의거하여 작성됩니다. 마지막 md가 MarkDown의 약자이죠!

그러므로 README를 작성하기 위해선 MarkDown 문법을 알아야 합니다.

 

자 그럼 이제 시작해보실까요~?

---

1. 제목(글머리) 작성 

# H1, 제목                                  
## H2, 부제목                            
### H3, 소제목
#### H4, 제목4
##### H5, 제목5
###### H6, 제목6

 

2. 리스트 작성

* 리스트 1
    - 리스트 2
        + 리스트 3

(번호를 붙이고 싶다면)
1. 리스트 1
2. 리스트 2
3. 리스트 3 

 

3. Text Style 변경

1. 이탤릭체(기울임꼴)
*기울임꼴*
_기울임꼴_

2. 볼드체(굵은 글씨)
**볼드**
__볼드__

3. 취소선
~~취소선~~

 

4. 코드 블록 추가하기

```
a
b
c
```
(숫자 1번 옆에 있는 악센트 기호
맥의 경우, option 키 + ~키 )

 

5. 인용

> 텍스트

> > 텍스트 (두 번 인용)

 

6. 수평선 넣기

4개 중에 골라서 쓰면 됨

***   
---
___
<hr/>

 

7. 이미지 추가하기

그냥 이미지 자체를 복붙 하면 알아서 주소화됨

(이미지 크기 조절)   
<img src="이미지 링크" width="너비 " height="높이">

 

8. 링크 달기 

(1) 인라인 링크
[텍스트](링크 주소)

(2) 참조 링크
[텍스트][참조명]
[참조명]: 링크 주소

 

9. 이모지 추가하기

Window key + . (윈도우키와 점 누르기)   
😊😂🤣❤   

 

10. 문자열 개행

방법 1) 문장 마지막에 스페이스 두 번 이상 입력
방법 2) <br> 태그를 사용

 

11. 체크박스

* [x] 체크박스
* [ ] 빈 체크박스

 

12. 표 넣기

|왼쪽 정렬|가운데 정렬|오른쪽 정렬|
|:---|:---:|---:|
|가|나|다|
|a|b|c|

 

이 정도만 알아도 충분히 README.md를 작성하실 수 있을 겁니다!!

 

실제 적용된 모습을 보고 싶으시다면 아래 들어가서 적용된 README를 확인해주세요~~https://github.com/hj-joo/MarkDown/blob/main/README.md

GitHub - hj-joo/MarkDown: 마크다운을 작성해봅시다.

 

그럼 이만~~

 

출처 : https://ko.wikipedia.org/wiki/%EB%A6%AC%EB%93%9C%EB%AF%B8