Github에서 Markdown 문법 사용하기

Github에서는 공식적으로 Markdown 문법을 사용할 수 있도록 해준다. 이 Markdown 문법이 적용 될 수 있는 범위는 Issue를 작성하거나, 댓글을 달거나, 혹은 Markdown file인 확장자가 .md파일을 볼 때 문법이 적용된 결과를 기본적으로 보여주며, 버튼을 눌러서 Raw 형태의 데이터를 볼 수 있다.

이 Markdown 문법은 몇 가지 작성 방식만 알고 있으면 매우 간단한 방법으로 멋진 모습을 가진 문서를 만들 수 있다는 장점이 있다. 즉 우리는 스타일시트에 대해 생각을 하지 않고도 보기 좋은 문서를 만들 수 있다는 것을 의미한다.

또한 소스코드를 문서상에 넣을 때에도 Highlight가 적용된 문서로 자동으로 만들어준다는 것이 매우 편리한 점이다. 당장 Tistory 블로그만 보더라도 소스코드를 Highlight를 시키기 위해서는 추가적으로 설치 및 설정을 해주어야 하는 것들이 많다.

하지만 매우 정형화된 형태로만 작성이 가능하다는 단점이 있다. 즉, 색깔을 화려하게 만들어서 넣거나 하는 기능이 없다는 것이다.

아래는 Github에서 사용하는 Markdown 문법에 대한 매뉴얼 링크들이다. 시간이 날 때, 번역해서 한 번에 정리해서 올리는 것을 생각해봐야겠다.

https://help.github.com/articles/github-flavored-markdown/

https://help.github.com/articles/writing-on-github/

https://help.github.com/articles/markdown-basics/

https://guides.github.com/features/mastering-markdown/