[TIL]Day 23. 마크다운에 대하여

오늘 포스팅은 개발자들 사이에서 흔하게 볼 수 있는 마크다운(Markdown) 문서에 대해 알아보겠습니다.

 

1. 마크다운이란??

 

"마크다운 (Markdown)은 마크업 언어의 일종으로, 존 그루버(John Gruber)와 아론 스워츠(Aaron Swartz)가 만들었다. 처음 이메일의 글쓰기 형식에 영감받아 python을 이용하여 html변환기를 만드면서 시작되었다. 마크다운 문법은 읽기도 쉽지만 쓰기도 쉽다는 장점이 있다. 그루버는 마크다운으로 작성한 문서를 HTML로 변환하는 펄 스크립트도 만들었다. 확장자는 .md를 쓴다."

 

웹 개발을 하거나 git 을 사용하다보면 확장자가 .md 인 파일을 종종 마주치게 되는 일이 있으실 겁니다. 보통 readme.md의 파일 명으로 작성되어 있기 때문에 별로 중요해 보이진 않는데요, 내가 작성한 코드에 대한 간략한 정보를 제공하기 위해 마크다운 언어로 작성한 것입니다. 

 

마크다운의 특징은 사용법이 쉬워서 간단한 문서를 금방 만들 수 있다는 것입니다. 또 컴퓨터가 이해하기 쉬워서 변환에도 큰 무리가 없다는 것이 장점입니다. 하지만 그만큼 다양한 형태의 문서를 만들 수 없다는 것이 단점이기 때문에 간단한 정보를 제공하는 용도로 사용하는 것이 좋습니다.

 

2. 마크다운의 장단점 

 

마크다운에 대한 장단점을 조금만 더 짚고 넘어가도록 하겠습니다.

 

2.1 마크다운의 장점

 

1. 간결하다.

2. 별도의 도구없이 작성가능하다.

3. 다양한 형태로 변환이 가능하다.

3. 텍스트(Text)로 저장되기 때문에 용량이 적어 보관이 용이하다.

4. 텍스트파일이기 때문에 버전관리시스템을 이용하여 변경이력을 관리할 수 있다.

5. 지원하는 프로그램과 플랫폼이 다양하다.

 

2.2 마크다운의 단점

 

1. 표준이 없다.

2. 표준이 없기 때문에 도구에 따라서 변환방식이나 생성물이 다르다.

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

 

3. 마크다운 문법

 

3.1 헤더(Header)

 

- 큰 제목

This is an H1
=============

 

- 작은 제목(부제)

This is an H2
-------------

 

- 여러 크기의 글머리들

# This is a H1
## This is a H2
### This is a H3
#### This is a H4
##### This is a H5
###### This is a H6

(h1~ h6은 html에서 사용하는 헤더와 같습니다.)

 

3.2 블럭 인용(BlockQuote)

 

블럭 인용은 이메일에서 사용하는 블럭인용 문자를 사용합니다.

> This is a first blockqute.
>	> This is a second blockqute.
>	>	> This is a third blockqute.

 

3.3 목록

 

순서 있는 목록들은 숫자와 점을 사용하여 표현합니다.

1. 첫번째
2. 두번째
3. 세번째

(이때 어떤 숫자를 입력하더라도 번호는 내림차순으로 정리됩니다)

 

순서 없는 목록들은 *, +, - 등을 사용합니다.

* 빨강
  * 녹색
    * 파랑

+ 빨강
  + 녹색
    + 파랑

- 빨강
  - 녹색
    - 파랑

 

3.4 코드

 

4개의 공백 또는 하나의 탭으로 들여쓰기를 사용하면 변환되어 들여쓰지 않은 행을 만날때까지 변환이 유지됩니다.

 

3.4.1 코드블럭

 

코드 블럭은 다음의 두 가지 방법을 사용할 수 있습니다.

• <pre><code>{code}</code></pre> 이용방식

• 코드블럭코드("```") 을 이용하는 방법

 

3.5 수평선

 

다음 표현들은 수평선을 만드는데 사용됩니다.

 

* * *

***

*****

- - -

---------------------------------------

 

3.6 링크

 

-참조 링크

[link keyword][id]

[id]: URL "Optional Title here"

// code
Link: [Google][googlelink]

[googlelink]: https://google.com "Go google"

 

-외부 링크

사용문법: [Title](link)
적용예: [Google](https://google.com, "google link")

 

-자동 연결

일반적인 URL 혹은 이메일주소인 경우 적절한 형식으로 링크를 형성한다.

* 외부링크: <http://example.com/>
* 이메일링크: <address@example.com>

 

3.7 강조 표현

 

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
~~cancelline~~

 

3.8 이미지

 

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

 

3.9 줄바꿈

 

문장 마지막에서 띄어쓰기를 3번 이상 사용하게 되면 줄바꿈을 사용하게 됩니다.

 

4. 마치며

 

요즘 Notion을 사용하는 기업이나 사이트가 늘어가고 있는데 Notion에서 작성한 문서는 Atom, Visual Studio Code, Notepad++텍스트 편집기에 복붙(복사하고 붙여넣기)하면 마크다운문법으로 작성된 문장이 기입된다고 합니다. 또 앞서 말씀 드렸던 것처럼 마크다운 언어를 잘 활용하면 내 git project를 더 멋있게 표현할 수 있기 때문에 활용법을 잘 익혀두면 좋을 것 같습니다.