마크다운 사용법

깃헙 README 문서를 작성하려다 보니 마크다운을 사용하게 되었습니다.

Jupyter notebook에서도 사용해보기는 했지만 간단한 제목정도만 작성했었기 때문에

문서작성을 위해 마크다운에 대해 자세히 알아보았습니다.

 

우선 마크다운이란 무엇인가에 대해 알아봅시다.

 

마크다운은 2004년 존 그루버가 작성한 언어로 일반 텍스트나 문서의 양식을 편집하는 언어라고 합니다.

README 파일이나 온라인 문서, 혹은 일반 텍스트 편집기로 문서 양식을 편집할 때 쓰이며, 마크다운을 이용해 작성된 문서는 쉽게 HTML 등 다른 문서형태로 변환이 가능하다고 합니다.

 

위키피디아를 참고했습니다.

 

 

Github의 readme 문서인 README.md 또한 이 마크다운으로 작성이 가능합니다.

 

그럼 바로 마크다운 문법에 대해 알아보도록 하겠습니다.

 

1. 제목

제목은 두 가지 방법으로 입력이 가능합니다.

첫째, 문서 제목 밑에 =========== 나 ------------- 를 입력해 입력 가능합니다.

큰제목
====
작은제목
----

이렇게 입력하면

이렇게 변환됩니다.

 

둘째, #표시를 입력해 입력 가능합니다.

# 제목1
## 제목2
### 제목3
#### 제목4
##### 제목5
###### 제목6

이렇게 변환됩니다.

 

2. 줄바꿈

마크다운 언어에서는 일반적으로 엔터를 치는 것으로는 본문 줄바꿈이 되지 않습니다.

줄바꿈을 하기 위해서는 몇가지 표시가 필요합니다.

첫째, HTML과 같이 <br>을 이용하는 방법입니다.

첫째줄<br>
둘째줄

이렇게 줄바꿈이 가능합니다.

하지만 마크다운 언어의 표현을 이용할 수도 있습니다.

 

둘째, 줄의 마지막에 공백을 두 번 입력합니다.

첫째줄  <-공백이 두 칸 입력되어있다
둘째줄

<br>을 사용한 것과 동일하게 줄바꿈이 됩니다.

 

그리고 한 줄을 띄고 싶을 때에는

셋째, 엔터를 두 번 입력합니다.

첫째줄

둘째줄

이런 식으로 입력 가능합니다.

이 때에는 줄 마지막에 공백을 두 번 넣어주지 않아도 됩니다.

 

 

3. 블럭 인용

블럭 인용은 > 표시를 이용해 입력 가능합니다.

인용
> 인용문

이렇게 입력 가능합니다.

 

 

4. 목록

목록에는 여러가지 종류가 있습니다.

 

첫째, 순서 있는 목록

순서 있는 목록은 숫자와 점으로 입력 가능합니다.

1. 첫째 목록
2. 둘째 목록
3. 셋째 목록

이렇게 입력됩니다.

 

참고로 순서 있는 목록은 숫자를 어떤 순서로 주던지 첫 번째 숫자를 기준으로 넘버링됩니다.

예를 들어서

1. 첫째 목록
12. 열두 번째 목록
514. 오백십사 번째 목록

이렇게 변환됩니다.

 

둘째, 순서 없는 목록

순서 없는 목록은 * + - 기호를 이용해 입력 가능합니다.

* 순서 없는 목록
	* 순서 없는 목록
		* 순서 없는 목록
        
+ 순서 없는 목록
	+ 순서 없는 목록
		+ 순서 없는 목록
        
- 순서 없는 목록
	- 순서 없는 목록
		- 순서 없는 목록

이렇게 입력됩니다.

 

참고로 부호를 섞어서 사용하는 것도 가능합니다.

* 순서 없는 목록
	+ 순서 없는 목록
		- 순서 없는 목록

이렇게 작성하면 문서 작성시에도 구분이 가능합니다.

 

 

5. 코드블럭

코드블럭은 ` 문자 세 개로 둘러싼 문단으로 만들 수 있습니다.

```
a = 1
b = a + 1
```

 

 

6. 하이퍼링크

하이퍼링크는 하이퍼링크를 입힐 텍스트를 []로 감싸고 뒤에 ()로 감싼 url을 붙여주면 됩니다.

[구글링크](https://www.google.com/)

이미지 링크를 하고싶다면 하이퍼링크 앞에 ! 를 붙이면 됩니다.

![구글로고](https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png)

물론 url은 이미지의 url을 입력해야 합니다.

잘못된 링크를 입력시 흔히 말하는 엑스박스가 표시되게 됩니다.

 

 

7. 문자 강조

여러가지 기호를 문장 앞뒤에 붙여 문장을 강조할 수 있습니다.

*이탤릭체*
_이탤릭체_
**굵은글씨**
__굵은글씨__
++밑줄++
~~취소선~~

 

 

8. 수평선

문서 안에 수평선을 넣어 문서를 구분할 수 있습니다.

* * *
문단1
***
문단2
*****
문단3
- - -
문단4

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

주의할 점은 -------- 는 제목의 문법과 겹치기 때문에 두 줄을 띄워주어야 수평선이 만들어집니다.

 

 

 

이상으로 간단하게 마크다운 문법들을 알아보았습니다.

 

마지막으로 웹에서 쉽게 마크다운을 테스트해볼 수 있는 사이트를 소개해 드리겠습니다.

https://dillinger.io/

Online Markdown Editor - Dillinger, the Last Markdown Editor ever.

이 사이트를 이용하면 입력과 동시에 적용된 마크다운을 확인하며 마크다운을 작성할 수 있습니다.

 

 

 

마크다운 언어로 readme 파일을 멋지게 꾸며봅시다.