[Github] README.md에서 자주 사용하는 문법 예제 15가지 총정리

 

 -  README.md 파일은 Markdown 언어를 사용하여 작성됨, 직관적이고 쉬운 문법 보유

 

 README.md 파일은 소프트웨어 프로젝트의 문서화에 사용되며, Markdown 언어를 사용하여 작성됩니다. Markdown은 텍스트를 HTML로 변환하기 위한 경량 마크업 언어로, 간단하고 직관적인 문법을 가지고 있습니다. 다음은 README.md 파일에서 자주 사용하는 Markdown 문법과 예제들입니다:

 

 

 

 

 

1. 제목: # 기호를 사용하여 제목을 작성합니다.

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

 

 

 

 

 

2. 볼드체: ** 또는 __ 를 사용하여 볼드체를 만듭니다.

**이 텍스트는 볼드체입니다**
__이 텍스트도 볼드체입니다__

 

 

 

 

 

3. 이탤릭체: * 또는 _ 를 사용하여 이탤릭체를 만듭니다.

*이 텍스트는 이탤릭체입니다*
_이 텍스트도 이탤릭체입니다_

 

 

 

 

 

4. 볼드 이탤릭체: *** 또는 ___ 를 사용하여 볼드 이탤릭체를 만듭니다.

***이 텍스트는 볼드 이탤릭체입니다***
___이 텍스트도 볼드 이탤릭체입니다___

 

 

 

 

 

5. 취소선: ~~ 를 사용하여 취소선을 만듭니다.

~~이 텍스트는 취소선이 적용되었습니다~~

 

 

 

 

 

6. 링크: [텍스트](URL) 형식을 사용하여 링크를 만듭니다.

[Google](https://www.google.com)

<https://www.google.com>

 

 

 

 

 

7. 이미지: [alt text](이미지 URL) 형식을 사용하여 이미지를 삽입합니다.

[GitHub Logo](/images/logo.png)
![GitHub Logo](/images/logo.png)

 

 

 

 

 

8. 블록 인용문: > 기호를 사용하여 블록 인용문을 만듭니다.

> 이것은 블록 인용문입니다.

> > > > 이런 것도 됩니다.

> ## 이것은 블록 인용문입니다.
> #### 내용은 여기 있어요
> 1. 이런 것도 된다.
> 2. ~~**신기하다**~~

 

 

 

 

 

9. 순서 있는 목록: 숫자와 점을 사용하여 순서 있는 목록을 만듭니다.

1. 첫 번째 항목
2. 두 번째 항목
3. 세 번째 항목
   1. 2depth 내용 야호
   2. 두번째
      1. 3depth 내용~

 

 

 

 

 

10. 순서 없는 목록: * 또는 - 또는 +를 사용하여 순서 없는 목록을 만듭니다.

* 항목 1
* 항목 2
* 항목 3
  * 2 깊이 내용
  * 나열~
    * 더 깊어지면 네모
    * 신기하다
      * 계속 네모
        * 또 네모

 

 

 

 

 

11. 인라인 코드: `내용` 또는 ```내용``` 을 사용하여 코드 블록을 만듭니다.

`println("Hi~"")`

``println("Hi~"")``

```
function helloWorld() { 
    console.log("Hello, world!"); 
}
```

 

 

 

 

12. 표: -와 |를 사용하여 표를 만듭니다.

| 헤더 1 | 헤더 2 |
|--------|--------|
| 셀 1   | 셀 2   |

 

 

 

 

 

13. 체크박스: - [ ]와 - [x]를 사용하여 체크박스를 만듭니다.

- [x] 완료된 항목
- [ ] 미완료된 항목

 

 

 

 

 

14. 수평선: --- 또는 ***를 사용하여 수평선을 만듭니다.

---
내용
***
내용

 

 

 

 

 

15. HTML: HTML 태그를 직접 사용할 수도 있습니다.

<u>밑줄</u>

## <span style="color:blue">파란색 텍스트</span>

<span style="color:red">빨간색 텍스트</span>