Markdown(마크다운) 설명 및 사용법

Markdown(마크다운)

마크다운이란?

웹 개발을 하면서 'README.md' 라는 파일을 간혹 볼 수 있는데, 이 파일이 바로 마크다운 문법으로 작성된 파일이다. 확장자는 .md이다. 마크다운은 텍스트 기반의 마크업 언어로 2004년 존 그루버와 에런 스워츠가 만들었다.

마크다운의 장점

쉽게 작성해 읽을 수 있고, HTML로 변환이 가능하다. 간단한 구조의 문법(문자 및 특수기호)을 사용해 웹에서 직관적이고 빠른 작성이 가능해 보다 편하게 문서를 정리할 수 있다. 또한 메모장부터 전용 에디터까지 많은 곳에서 활용할 수 있다.

요약

1. 문법이 쉽고 간결하며 별도의 도구 없이 작성 가능.
2. 텍스트(.txt)로 저장되기 때문에 용량도 적어 보관이 용이하고 관리도 쉬움.
3. 지원하는 플랫폼과 프로그램이 다양함.

마크다운의 단점

사용법이 쉽고 빠르게 정리가 가능하지만, 표준이 없어 사용자에 따라 문법이 다를 수 있고, 모든 HTML 마크업을 대신할 수 없기 때문에 지나친 의존을 하면 안된다.

요약

1. 표준이 없어 사용자마다 문법이 다름.
2. 모든 HTML 마크업을 대신할 수 없음.

---

마크다운 문법 및 사용법

1. 제목(Header)

기본 문법: '#'을 이용한다.

# This is h1
## This is h2
### This is h3
#### This is h4
##### This is h5
###### This is h6
####### this is h7 = 출력되지 않음

아래는 적용 예시

This is h1

This is h2

This is h3

This is h4

This is h5

This is h6

####### this is h7 = 출력되지 않음

2. 강조(Emphasis)

기울여 쓰기는 *별표* 또는 _언더바_를 사용.
굵게 쓰기는 **별표 2개** 또는 __언더바 2개__를 사용.
기울여 쓰기와 굵게 쓰기를 같이 쓰려면 **_언더바_와 별표 2개**를 같이 쓰면 된다.
취소줄은 ~~물결 2개~~를 사용.
밑줄 긋기는 <>안에 'u'를 넣어 사용해야 한다.

!주의! 문장 중간에 쓸 경우엔 띄어쓰기를 해야 한다.

아래는 적용 예시

기울여 쓰기는 별표 또는 언더바 를 사용.
굵게 쓰기는 별표 2개 또는 언더바 2개 를 사용.
기울여 쓰기와 굵게 쓰기를 같이 쓰려면 언더바 와 별표 2개를 같이 쓰면 된다.
취소줄은 물결 2개 를 사용.
밑줄 긋기는 <>안에 'u'를 넣어 사용해야 한다.

3. 목록(List)

순서가 필요한 경우엔 '1.' 같은 숫자 표기를 이용, 순서가 필요하지 않은 경우엔 '-, +, *'를 이용한다. 계층을 나누고 싶으면 'tab'키를 이용한다.

1. 순서가 필요
    1. 순서
    1. 순서
1. 순서 필요와 인 필요
    - 순서X
    * 순서X
+ 순서 안 필요할 때
    - 순서X
       * 순서X

아래는 적용 예시

1. 순서가 필요
   1. 순서
   2. 순서
2. 순서 필요와 안 필요
   • 순서X
   • 순서X

• 순서 안 필요할 때
  • 순서X
    • 순서X

4. 링크(Links)

기본 문법: [링크 문구](링크 주소)

<>안에 주소 넣기 https://www.google.com/

물론 그냥 갖다 넣어도 됩니다. https://www.google.com/

[타이틀 예시](https://www.daum.net/)

[타이틀과 설명 있는 예시](https://www.naver.com/ "링크 설명 쓰세요")

[참조 링크 예시][1]

[내부 링크 예시][내부 링크]

참조와 내부 둘 다 본문을 쓴 뒤, 하단에 링크를 써둡니다. [링크 첨부]하는 방법 참 쉽죠?

[1]: https://terms.naver.com/entry.nhn?docId=835089&cid=42344&categoryId=42344
[내부 링크]: https://malgun-gothic.tistory.com/
[링크 첨부]: https://www.youtube.com/watch?v=cbuZfY2S2UQ "여기도 설명 가능"

아래는 적용 예시

https://www.google.com/

물론 그냥 갖다 넣어도 됩니다. https://www.google.com/

타이틀 예시

타이틀과 설명 있는 예시

참조 링크 예시

내부 링크 예시

참조와 내부 둘 다 본문을 쓴 뒤, 하단에 링크를 써둡니다. 링크 첨부하는 방법 참 쉽죠?

5. 이미지(Images)

기본 문법: 

![사진이름](https://pbs.twimg.com/media/EB5Pq3rVUAAYjxI.jpg)

![사진 설명](https://blog.kakaocdn.net/dn/SsiOY/btqA5PDy7Yw/98FHdtOCdK8wjyKFS7wuxK/img.jpg "설명쓰세요")

![참조 사진][쿼카]

링크 참조와 비슷한 방법을 씁니다!

[쿼카]: https://pbs.twimg.com/media/EcaW8FFUYAIOi_P.jpg "여기도 설명가능"

아래는 적용 예시

링크 참조와 비슷한 방법을 씁니다!

6. 코드(Code)

기본 문법: ' `(~) '를 사용

```
1. 블록(block) 코드 강조는 이 문장같이 `를 위, 아래로 3번 사용한다. 본문은 가운데에 위치.
```
1-1. 또한 블록 코드는 특정 언어를 명시해주면, 문법에 대한 색이 바뀐다. (예시로 C언어 지정)

``` c
int val = 10;
printf(%s,"Hello, World!");
```

인라인(inline) 코드 강조는 `를 문장 앞뒤에 1번 사용해 속한 글의 색`을 바꾼다.

아래는 적용 예시

1. 블록(block) 코드 강조는 이 문장같이 `를 위, 아래로 3번 사용한다. 본문은 가운데에 위치.

1-1. 또한 블록 코드는 특정 언어를 명시해주면, 문법에 대한 색이 바뀐다. (예시로 C언어 지정)

int val = 10;
printf(%s,"Hello, World!");

인라인(inline) 코드 강조는 를 문장 앞뒤에 1번 사용해 속한 글의 색을 바꾼다.

7. 표(Table)

'|'를 이용해 테두리를 만듬. 이때 가장 좌측과 우측은 생략 가능.
헤더 셀을 구분할 때는 3개 이상의 '-' 기호가 필요함. 셀 정렬은 ':'기호를 이용.

정렬을 사용하지 않은 기본 테이블
이름|자|비고
---|---|---
유비|현덕|삼
관우|운장|국
장비|익덕|지

정렬을 사용한 테이블
이름|자|비고
:---|:---:|---:
(순서대로 왼쪽 정렬, 가운데 정렬, 오른쪽 정렬)
유비|현덕|삼
관우|운장|국
장비|익덕|지

아래는 적용 예시

정렬을 사용하지 않은 기본 테이블

이름	자	비고
유비	현덕	삼
관우	운장	국
장비	익덕	지

정렬을 사용한 테이블

이름	자	비고
유비	현덕	삼
관우	운장	국
장비	익덕	지

8. 인용문(BlockQuote)

내용을 쓰는 중 인용된 글을 표시할 때 '>'를 인용글 앞에 붙여 사용한다. '>'의 개수에 따라 들여쓰기 단계 조정.

중첩 인용 사용.

>인용글 1단계
>>인용글 2단계
>>>인용글 3단계

인용문 내 줄 바꾸기는 '>' 사용,

>인용글
>또 인용글
>또한 인용글

혹은 'tab'키 이용.

>인용글
    >또 인용글
        >이것 또한 인용글

중첩 인용 및 스타일 적용

>인용하자
>>무엇을?
> #### 인용문 내부 헤더

아래는 적용 예시

중첩 인용 사용.

인용글 1단계

인용글 2단계

인용글 3단계

인용문 내 줄 바꾸기는 '>' 사용,

인용글
또 인용글
또한 인용글

혹은 'tab'키 이용.

인용글
또 인용글
이것 또한 인용글

중첩 인용 및 스타일 적용

인용하자

무엇을?

인용문 내부 헤더

9. 수평선(Horizontal Rule)

기본 문법: '---, ***, ___'와 같은 기호를 3개 이상 입력.

---
하이퍼 이용

***
별표 이용

___
언더바 이용

아래는 적용 예시

---

하이퍼 이용

---

별표 이용

---

언더바 이용