마크다운 README 작성법

마크다운이란?

마크다운(markdown)은 일반 텍스트 기반의 경량 마크업 언어입니다.
또한 일반 텍스트로 서식이 있는 문서를 작성하는 데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징입니다
이러한 특징으로 인해 HTML과 리치 텍스트(RTF) 등 서식 문서로 쉽게 변환되기 때문에 응용 소프트웨어와 함께 배포되는 README 파일이나 온라인 게시물 등에 많이 사용됩니다.

마크다운 에디터

• notion
• vscode (markdown extension 설치)

예시

마크다운을 사용해서 작성한 README

문법

• 마크 다운에 대한 문법 정리

1 제목 작성
2 순서가 있는 목록
3 순서가 없는 목록
4 폰트 스타일
5 인용문 작성
6 인라인 코드
7 수평선
8 테이블
9 todo box
10 이미지 넣기
11 코드 삽입

---

제목 작성

# (h1)
## (h2)
### (h3)
##### (h4)
###### (h5)
####### (h6)

제목 작성 예시

h1

h2

h3

h4

h5

h6

---

순서가 있는 목록

 1. 하나
 2. 둘
 3. 셋

순서가 있는 목록 예시

1. 하나
2. 둘
3. 셋

---

순서가 없는 목록

- 목록1
   - 목록2(tab 한번의 간격) 
       - 목록3

순서가 없는 목록 예시

• 목록1
  • 목록2
    • 목록3

---

폰트 스타일

__bold__
**bold**
_italic_
*italic*
~cancle~
~~cancle~~

폰트 스타일예시

bold
bold
italic
italic
cancle
cancle

---

인용문 작성

> 인용문 
- 김언동 

> 인용문을 활용하면 
>> 별것도 아닌일이 
>>> 명언처럼 보인다 

인용문 작성 예시

인용문
-김언동

인용문을 활용하면

별것도 아닌일이

명언처럼 보인다

---

인라인 코드

` 이렇게 통으로 작성할수 있고`
아니면 `하나만` 강조하는 느낌으로 만들수 있습니다 

인라인 코드 예시

이렇게 통으로 작성할수 있고
아니면 하나만 강조하는 느낌으로 만들수 있습니다

---

수평선

***

수평선예시

---

---

테이블

| 이것은 | 테이블 | 예제 |
|:----------|:----------:|----------:|
| test 1  | test2 | test3 |
| test 1  | test2 | test3 |
| test 1  | test2 | test3 |

테이블 예제

이것은	테이블	예제
test 1	test2	test3
test 1	test2	test3
test 1	test2	test3

---

todo box

[] 할일
[x] 한일 

todo box 예제

[] 할일 [x] 한일

---

이미지 넣기

<img src="./mdimage.png" /> 

이미지 넣기 예시

---

코드 삽입하기

    ```js
        console.log("hello world")
    ```

코드 삽입하기 예제

console.log("hello world")

---

정리

• README를 작성하기 위해서 우선 마크다운 작성법에 대한 정리를 했다.
• 위 기본 문법만 알고있다면 간단하게 깔끔한 README를 작성할수 있을것이다.