https://gist.github.com/ihoneymon/652be052a0727ad59601
마크다운(Markdown) 사용법
마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.
gist.github.com
Git을 사용하다 보면 README.md 파일이 자동으로 생성되거나, 혹은 수동으로 생성했을 때 적어야 하는 경우가 있다.
README.md 마크다운 작성법에 대해서 공부도 할 겸 적어보려 한다.
1. README.md
리드미(README) 파일은 해당 디렉토리, 파일에 대한 정보를 가지고 있으며 Git, Github 같은 원격 저장소에서 많이 보이는 파일 중 하나다. 일반적으로 컴퓨터 소프트웨어와 함꼐 배포되며 대개 다음 주 하나 이상이 포함된다.
- 컴퓨터 구성 안내
- 설치 안내
- 사용법
- 파일 메니페스트 (파일 목록 포함)
- 저작권 및 사용권 정보
- 배포자 및 프로그래머의 연락처 정보
- 알려진 버그
- 트러블슈팅
- 크레딧
- 체인지 로그 (대개 프로그래머용)
- 새 소식 단락 (대개 사용자용)
주로 해당 프로젝트의 버전 기록, 변경사항, 파일 목록 등등을 작성하여 사용자들이 변경사항이나 특이사항을 한 눈에 확인할 수 있도록 한다.
2. 마크 다운(Markdown)
일반적으로 우리가 블로그에 사용하는 것처럼 엔터키 한번으로 자동으로 줄바꿈이 처리되거나 간단한 리스트 혹은 코드 블럭 등의 강조 사항들을 손쉽게 적용할 수 있지만, REAMDME 파일을 작성할 때에는 그렇지 않다. 여기서 마크다운이라고 하는 것이 사용된다.
마크다운은 텍스트 기반의 마크업 언어로 2004년 존 그루버에 의해 만들어졌다.
쉽게 쓰고 읽을 수 있으며 HTML로의 변환이 가능하고, 특수기호와 문자를 이용하여 매우 간단한 구조의 문법으로 빠르게 컨텐츠를 작성할 수 있다.
마크다운의 장점
- 간결하다.
- 별도의 도구 없이 작성 가능
- 다양한 형태로 변환 가능
- 텍스트 형태로 저장되기 때문에 용량이 적어 보관 용이.
- 텍스트 파일이므로 버전관리 시스템을 이용하여 변경 이력 추적, 관리 가능.
- 지원하는 프로그램과 플랫폼이 다양하다
마크다운의 단점
- 표준이 없기 떄문에 도구에 따라서 변환 방식이나 생성되는 결과물이 다름.
- 모든 HTML 마크업을 대신할 수 없다.
3. 주로 사용하는 마크다운 문법
현재 본인이 git을 사용하면서 주로 사용하는 마크다운 위주로 작성하려 한다.
1. 헤더(Headers)
# H1
## H2
### H3
#### H4
##### H5
###### H6
제목을 강조할때 사용하는 헤더.
#과 같은 형태로 표시하기도 하지만 큰 제목은 =====, 소제목은 ---------- 등으로 처리하기도 한다.
2. 목록
순서있는 목록
1. 첫번째
2. 두번째
3. 세번째
앞에 번호를 매겨준다( 1, 2, 3...)
순서는 내림차순으로 정의된다.
순서없는 목록
* 빨강
* 초록
* 파랑
+ 빨
+ 파
+ 초
- 빨
- 파
- 초
주로 -, *을 많이 사용하는데, 티스토리에서 블로그를 작성할 때 상단 탭에 리스트 기능과 비슷하다고 생각하면 된다.
3. 코드블럭
코드 블럭은 ```로 구분지으며, 끝날때도 동일하게 ```를 쳐서 마무리한다.
첫 시작 코드블럭에 해당하는 언어를 적어주면 (ex) ```java ~ ```) 해당 언어의 형태로 강조 할 수 있다.
4. 링크
[Title] (link주소) 형태로 사용하며 콤마 뒤에는 마우스 커서를 해당 하이퍼링크에 올렸을 때 설명이 표시되도록 처리할 수 있다.
5. 강조 및 줄바꿈
* 사이에 문자를 입력하면 기울임꼴을 작성할 수 있다.
** 또는 __ 사이에 문자를 입력하면 강조 문법을 작성할 수 있다.
강조 문법은 문장 중간에 사용할 경우 띄어쓰기를 사용하는 것이 좋다.
줄바꿈은 문장 마지막에서 3칸 이상 띄어쓰기를 하면 줄이 바뀌며
엔터키 두번은 문단을 바꾸는 것이므로 헷갈리지 않도록 한다.
