[마크 다운/MD] 마크 다운(Markdown) 문법, readme.md 파일 작성
Markdown은 2004년 개발된, plain-text formatting syntax를 위한 경량형 마크업 언어(lightweight markup language)이다. 주피터 노트북이나 깃허브 등에서 주석을 형성하거나 readme 파일 등을 작성하는데에 자주 사용된다. 자주 사용되는 기본적인 문법을 정리해보려한다.
0) vscode에서 눈으로 보며 편집하기
vscode에서 작성하려는 markdown 파일(.md)을 열어둔 상태로, 단축키 'ctrl+shift+v'를 누르면 'markdown preview'를 실행할 수 있다. 아래처럼 좌우 별도의 창으로 구성하면, 입력하는 markdown 파일의 미리보기를 보며 작성할 수 있어 유용하다.
1) Heading(#)
# 1개부터 6개까지 가능하며, 개수가 늘어날수록 heading의 크기는 작아진다. #을 하나만 사용할 경우, 보이는 것처럼 제목 밑에 자동으로 구분선이 생긴다. 직접 구분선을 추가하고 싶다면 ___를 입력하면 된다.
2) Text attributes (bold, italic 등)
아래 예시처럼 글씨 꾸미기가 가능하다.
줄바꿈은 html 태그인 </br>을 활용하면 된다.
3) Quote
인용구는 >를 활용하면 된다.
4) List(Bullet, Number)
점 혹은 숫자 목록은 아래와 같이 형성할 수 있다.
5) Link
하이퍼링크를 삽입하고 싶은 경우는 [here](링크)를 활용하자.
6) Image
이미지 삽입 두 가지 방법이 가능하다.
 혹은 html 태그 <img>를 활용하면 된다.
이미지 사이즈를 직접 설정하기 위해서는, 후자가 좋다.
만약 로컬에 파일로 가지고 있는 이미지를 활용하고 싶다면, github의 issues에서 new issue를 클릭한 뒤, 이미지를 붙여 넣으면 나오는 이미지 링크를 활용하면 된다. (submmit new issue를 클릭할 필요는 없다.)
7) Table
표는 '|'을 이용해 아래와 같이 만들 수 있다.
컬럼별 정렬이 가능한데, 표의 header에 해당하는 부분들을 작성해준 뒤에 아래에 |--|--|--| 부분에 :을 위치시키면 된다. 왼쪽 정렬을 원하면 가장 왼쪽에, 오른쪽 정렬을 원하면 오른쪽에, 가운데 정렬을 원하면 양쪽에 :을 추가해주자.
8) Code 삽입
코드 블럭을 형성하고, 각 코드에 맞게 highlight를 부여할 수 있다.
백틱(`)을 이용하며, 텍스트 중간에 코드를 삽입하거나 특정 언어의 코드블럭을 형성해 코드를 입력할 수 있다.
9) 그 외
외에도 깃허브에서는 'Github Flavored Markdown'이라는 것을 지원해, 기존의 마크다운에 몇몇 기능이 추가된 것을 제공한다고 한다. 깃허브 내에서 readme.md 파일을 만들 때 가독성을 높이기 위해 참고하면 좋을 것 같다.(https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
또한 HTML을 지원하기 때문에 TeX 문법을 활용해 수식을 입력할 수 있다.
[참고]