본문 바로가기

Git

[Markdown] README.md 를 작성해보자

Markdown은 텍스트 기반의 마크업언어로 2004년 존그루버에 의해 만들어졌으며 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다. 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다. 


마크다운이 최근 각광받기 시작한 이유는 깃헙(https://github.com) 덕분이다. 


깃헙의 저장소Repository에 관한 정보를 기록하는 README.md는 깃헙을 사용하는 사람이라면 누구나 가장 먼저 접하게 되는 마크다운 문서였다. 마크다운을 통해서 설치방법, 소스코드 설명, 이슈 등을 간단하게 기록하고 가독성을 높일 수 있다는 강점이 부각되면서 점점 여러 곳으로 퍼져가게 된다.


(출처 : https://gist.github.com/ihoneymon/652be052a0727ad59601)


- 마크다운 작성법

1. 제목

마크다운의 제목 작성법은 '#'을 이용한 방법과 '----'을 이용한 방법 두가지로 분류된다.


1.1 '#'을 이용한 방법

- 제목은 "#"으로 지정 할 수 있다.

- "#"과 글자는 한칸의 공백이 들어가야 한다.

- "# 큰제목", "## 중간제목", "### 작은제목" 3가지가 존재한다.


1.2 '-'을 이용한 방법

- 글 다음줄에 "====="를 이용하여 라인을 그어주면 큰제목이 된다.

- 글 다음줄에 "-----"를 이용하여 라인을 그어주면 중간제목이 된다.


1.3 예시

깃허브 참조 : https://github.com/YoonKyoungTae/Markdown

태그