카테고리 없음

README 작성하는 Markdown

히새 2023. 7. 21. 15:28

과제를 하던 도중, README 작성법을 찾아보다가 다음에 내가 보기 위해 작성합니다.

( 사실은 저번에 정리해서 포스팅 해둔 줄 알고 보러왔다가 포스팅 안해놔서 급히 포스팅합니다 )

 

 

vscode 를 사용하였습니다.

 

 

오른쪽 위의 Markdown Preview Enhanced 칸을 이용해 미리보기를 켜면 수월합니다!


🎈 Heading 제목

 

# 개수를 이용하여 작성 

heading 1 - 글자 아래 수평선 자동 추가

heading 2

heading 3

heading 4

heading 5

heading 6

 

🎈 줄바꿈

 

<br/> 혹은 띄어쓰기 두 번 후 엔터

 

 

🎈 Paragraph 문단

 

아무것도 작성하지 않고 텍스트 바로 입력

 

 

🎈 Line 가로줄

 

---

----------

- - -

***

**********

* * *

 

가로 줄을 추가할 수 있다.

 

 

 

🎈 Text attributes 텍스트 속성

 

 ** bold ** - bold

* italic * - italic

~~ strickthrough ~~ - strikethrough

 

효과가 일어나서 중간에 띄어쓰기를 넣었습니다. 작성하실 때에는 띄어쓰기를 없애주세요!

 

 

🎈 Quote 인용

 

> quote

>> quote

>>> quote

 

 

🎈 Bullet List 순서가 없는 목록

 

텍스트 앞에

 

+

*

-

 

붙히기

 

 

 

🎈 Numbered List 순서가 있는 목록

 

앞에 숫자 붙혀주기

 

1. 리스트 a

2. 리스트 b

3. 리스트 c

 

 

🎈 Link 링크

 

- < 링크 주소 >

- [ 링크 텍스트 ] ( 링크 주소 )

- [ 링크 텍스트 ] ( 링크 주소, "부가설명" )

       마우스를 대면 부가설명이 뜬다.

 

 

🎈 Image 이미지

 

![ 이미지 설명 ](http:// ) - 대괄호 안에 이미지에 대한 설명 / 소괄호 안에 이미 링크 작성

 

 

🎈 Table 표

 

|Header|Description|

|—|—|

|Cell1|Cell2|

|Cell1|Cell2|

|Cell1|Cell2|

 

|:—| 왼쪽 정렬

|—:| 오른쪽 정렬

|:—:| 가운데 정렬

 

Cell1 Cell2
Cell1 Cell2
Cell1 Cell2

 

 

 

🎈 Code 코드

 

코드 작성하고 싶을 때엔 백틱 ( ` ) 키로 묶어주기

코드블럭

``` 해당 코드의 language
console.log('your message')
```

백틱 ( ` ) 키 3번으로 묶어주기

 

 

🎈 Task List 체크리스트

 

[    ]  : 체크박스 해제

[ x ]  : 체크박스 선택