본문 바로가기
GitHub

Readme를 위한 마크다운(.md) 작성법

by 강예은 2023. 4. 21.

Readme.md 파일은 확장자에서 볼 수 있듯 마크다운언어로 작성됩니다. 이외에도 깃허브로 TIL을 작성할 때 유용하게 사용가능하므로 기본적인 작성법을 포스팅 하겠습니다.

1. 헤더

여섯 개까지 사용 가능. 두 개까지는 밑선이 그어지고 여섯 개는 색도 옅어짐

# 해시태그 하나
## 해시태그 둘
### 해시태그 셋
#### 해시태그 넷
##### 해시태그 다섯
###### 해시태그 여섯
####### 해시태그 일곱

2. 왼쪽 선 긋기

개수 제한 없이 들여쓰기로 사용 가능

> 꺽쇠 하나
>> 꺽쇠 둘
>>> 꺽쇠 셋
>>>> 꺽쇠 넷

 

3. 리스트

*, +, - 를 사용함. 기호와 문자 사이에 공백이 있어야하고 탭(Tab)을 누르면 들여쓰기한 리스트 모양이 바끰

* 별리스트
  * 별리스트
    * 별리스트

+ 플러스리스트
  + 플러스리스트
    + 플러스리스트

- 마이너스리스트
  - 마이너스리스트
    - 마이너스리스트

4. 코드블럭

백틱키(`) 세 개를 나열하여 생성

밑에서부터 코드블럭 작성
```
    public class CodeBlock
```
작성 완료

 

5. 수평선

*, - 를 이용함. 3개 이상부터 되며 --- 는 가는 줄임

**
***
****
*****
--
---
----
-----

6. 하이퍼링크

하이퍼링크 <- 여기에 링크를 넣고 싶을 때

[하이퍼링크](https://url)

7. 기울임꼴   굵게  취소선

*italics type*

_italics type_

**bold type**

__bold type__

~~cencelline~~

 

'GitHub' 카테고리의 다른 글

GitHub TIL 작성법, repository 생성/삭제  (0) 2023.04.20