Markdown문서 개념과 작성법

Markdown 문서란?

GitHub 소스를 참고하다보면 README.md 라는 파일이 흔하게 보인다.

README.md 파일의 md는 markdown의 약어이다.

markdown 문서는 간단하고 읽기 쉬운 형식으로 텍스트를 작성하는 경량 마크업 언어이다.

현재 글을 쓰고 있는 tistory에서도 markdown 형식의 글작성도 지원하고 있다.

---

💡 README.md란?
README.md 파일은 GitHub 프로젝트 또는 저장소의 설명서로 사용된다.

보통 마크다운 문서로 작성되어 간결하고 가독성이 좋게 작성된다.

내용으로는 프로젝트 이름과 설명, 설치 방법, 사용예시, 라이센스, 저작권, 배포자 등의 정보가 포함된다.

장점

• 문법이 쉽고 간결하다.
• 관리가 쉽다.
• 호환성이 좋다.

단점

• 표준이 없다.
• 같은 문법이여도 결과물이 다를 수 있다.
• HTML마크업을 대신하지 못한다.

 

Markdown 문서 작성법

제목 작성법

# 제목1-H1
## 제목2-H2
### 제목3-H3
#### 제목4-H4
##### 제목5-H5
###### 제목6-H6

 

리스트 작성법

1. 숫자 목록 1
2. 숫자 목록 2

-기호목록 1
*기호목록 2
+기호목록 3

 

문자 스타일

_이텔릭_  
**두껍게**  
~~취소선~~  
<u>밑줄</u>

인용문 작성법

> 인용문 1
>
> >  인용문 2
> >
> > > 인용문 3

 

표 작성법

| 컬럼1 |    컬럼 2    | 컬럼3 |
| ------| :---------: | ----: |
| 1     |     데이터1  |     O |
| 2     |     데이터2  |     X |
| 3     |     데이터3  |     X |
| 4     |     데이터4  |     X |