Github에서 Markdown 문법 사용하기

>0. 들어가며

라이트업을 참고하면서 gitbub로 라이트업을 제출하시는 분들을 많이 보게 되었다. 나도 pdf를 github에 업로드하는 방식으로 라이트업을 작성해보긴 했지만 아래 사진처럼 글 + 코드를 마크다운 형식으로 작성해 본적은 없었다. 어떻게 저런 형식의 글을 쓸 수 있는지 알아보고 싶어 글을 쓰게 되었다.

 

오늘은 마크다운 문법, md란 무엇인지 그리고 어떻게 마크다운 문법을 사용하는지 정리해보려고 한다.

 

 

 

>1. 마크다운(Markdown)이란?

Markdown은 일반 텍스트 기반의 경량 마크업 언어이다. 텍스트만으로 서식이 있는 문서들을 작성할 때 자주 사용되며, 다른 마크업 언어들에 비해 문법이 쉽고 간단한 것이 특징이다. HTMl 등의 서식 문서들로 쉽게 변환되기 때문에 README 파일 등에 자주 사용된다. 마크 다운 문법은 https://gist.github.com/ihoneymon/652be052a0727ad59601 해당 링크를 참고하자.

• Markup Language: 마크(Mark)로 둘러싸인 언어이다. 태그(Tag)로 둘러싸였다고 표현하기도 한다. 마크업 언어들은 문서의 구조를 정의하며,대표적인 마크업 언어로는 HTML, XML 등이 있다.

 

 

>1.2. 마크 다운의 장단점

장점

1. 문법이 간결하고 쉽다.

2. 거의 대부분의 작업 환경에서 사용 가능하다(웹 사이트, 문서, 메모, README 파일 등)

3. 마크 다운을 지원하는 플랫폼이 다양하다(Girhub, Notion, Discord 등)

4. 텍스트로 저장되어 용향을 많이 차지하지 않는다.

 

단점

1. 표준이 없기 때문에 툴에 따라 생성물이 다르다.

2. 마크 다운으로 파일을 업로드할 때 저장 이후 파일 경로를 입력해야 한다.

3. 모든 HTML의 마크업을 대신하지 못한다.

 

 

 

 

 

>2. MD 파일 형식이란

Github의 리포지토리를 살펴보면 이렇게 README.md 형식의 파일을 볼 수 있다. MD 파일(Markdown 파일)은 마크 다운 언어를 사용하여 텍스트 형식을 지정하는 텍스트 기반 파일이다.

 

 

 

마크 다운 언어는 일반적으로 md 확장자를 가지는 파일에서 사용될 때 적용된다. 즉 md 확장자가 아닌 다른 확장자에서는 마크 다운 문법이 적용되지 않는다. 아래 사진의 경우 확장자를 설정하지 않고 github에 업로드했다. 이 경우 마크 다운 문법이 적용되지 않는 것을 볼 수 있다.

 

하지만 마크 다운 언어를 지원하여 웹 자체에서 마크 다운 문법을 해석할 수 있는 곳도 있다. 이 경우 md 확장자를 가지지 않아도 마크 다운 문법이 적용된다.

 

 

 

 

 

>3. 마크 다운 문법을 적용하여 Github에 글 올리기

3.1. Gitbub에서 작성하기

Add file -> Create new file 버튼을 눌러 새로운 md 파일을 작성한다.

 

 

3.2. Vscode로 md 파일 생성 후 Github에 업로드

먼저 Markdown All in One을 설치한다.

 

md 확장자 파일을 생성하고 '측면에서 미리 보기 열기'를 클릭한다.

 

그러면 이렇게 분활된 화면이 나타난다. 왼쪽 화면은 내가 마크 다운 문법을 입력하는 부분, 오른쪽 화면은 내가 입력한 문법들이 실제로 어떻게 나타나는지 미리 볼 수 있는 부분이다.

 

파일을 저장한 뒤 github에 업로드한다. (참고 https://sonowhstudy.tistory.com/23)

정상적으로 업로드 되었고, 업로드한 파일을 살펴보면 마크 다운 문법이 잘 적용된 것을 확인할 수 있다.