효율적인 개발자들을 위한 코드로 문서관리하기

 

마크다운(markdown)

일반 텍스트 문서의 양식을 편집하는 문법.

README 파일이나 온라인 문서, 혹은 일반 텍스트 편집기로 문서양식을 편집할 때 쓰입니다.

마크다운을 이용해 간단하게 기록하고 가독성을 높이는 문서를 작성 할 수 있습니다.

지금 쓰고있는 노션(notion) 또한 마찬가지!

 

 

추가적으로 알면 좋을 필수 문법!

이것까지 알면 효율적인 문서 작성 하기 완벽 마스터

 

 

기본 문법

제목(header)

# 의 개수에 따라 h1 ~ h6 까지 구분합니다.

# h1
## h2
### h3
#### h4
##### h5
###### h6

🛠 결과

h1

h2

h3

 

 

목록 (리스트)

순서가 있는 목록

숫자와 . 을 사용하여 작성합니다.

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

🛠 결과

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

순서가 없는 목록

-, *, + 을 사용하여 작성합니다.

Tab 키나 스페이스 바를 이용해 들여쓰기 합니다.

- 순서 없는 목록1
	- 순서 없는 목록 2
		- 순서 없는 목록 3

🛠 결과

• 순서 없는 목록1
  • 순서 없는 목록2
    • 순서 없는 목록3
    • 순서 없는 목록4

 

 

강조(Emphasis)

🛠 결과

이택릭체는 * 혹은 _ 감싸기

두껍게는 ** 혹은 __ 감싸기

취소선은 ~~ 감싸기

밑줄은 <u></u> 사용

 

 

코드 블럭

``` 으로 감싸기

``` 
코드블럭 작성 가능 

```
```

🛠 결과

코드블럭 작성 가능

 

 

인라인 코드

` 으로 감싼 텍스트

` 인라인 `

🛠 결과

인라인

 

 

 

문단

문단과 문단 사이는 줄바꿈으로 구분합니다.

첫번째 문단 

두번째 문단

🛠 결과

첫번째 문단

 

두번째 문단

 

 

링크

[타이틀](링크값)

[google](https://google.com,"google link")

 

 

수평선

---

페이지를 나누는 용도로 많이 사용합니다.

 

🛠 결과

데브노트 1

---

데브노트 2

 

 

 

 

이미지


![Alt text](/images/devnote.jpg) //이미지 설명 없이!
![devnote](/images/devnote.png "데브노트 이미지") //이미지 설명은 옵션!

 

🛠 결과