[마크다운, Markdown] 깃(Git)의 README.md 작성 방법

Git에서 README.md파일을 작성할 때, 사용하는 문법은 Markdown 문법이다.

cf) Markdown이란?

Markdown(마크다운)은 일반 텍스트 문서의 양식을 편집하는 문법이다. README 파일이나 온라인 문서, 혹은 일반 텍스트 편집기로 문서 양식을 편집할 때 쓰인다. Markdown을 이용해 작성된 문서는 쉽게 HTML 등 다른 문서형태로 변환이 가능하다.

제목

제목을 정할 때는 '#'을 이용해 강조한다. 무조건 '#'과 제목사이에 공백을 한칸 넣어야 완벽하게 변환이 된다. 최대 6개까지 지원한다.

# 가장 큰 크기의 제목 ## 2번째로 큰 제목 ### 3번째로 큰 제목 #### 4번째로 큰 제목 ##### 5번째로 큰 제목 ###### 6번째로 큰 제목

 

 

문단

문장 사이에 하나 이상의 빈 줄을 사용하면 문단을 나눌 수 있다. 마크다운 편집 모드에서는 빈줄을 여러 번 입력해도 한줄만 적용된다.

hello bye

 

 

목록

- 순서 없는 목록

문장 맨 앞에 공백없이 `*` 나 `-`를 입력하면 순서 없는 목록을 만들 수 있다. `*` 앞에 공백을 넣으면 안되지만, `*` 다음에는 공백을 넣어야 한다. 만일 `*` 다음에 공백을 넣지 않으면 강조로 인식할 수 있다.

* item1 * item2 * item3 - item4 - item5 - item6

 

- 순서 있는 목록

글 앞에 숫자를 입력하면 순서 있는 목록을 만들 수 있습니다. 순서와 상관없이 입력해도 자동으로 숫자가 매겨집니다.

1. 첫 번째 2. 두 번째 3. 세 번째 1. 네 번째 1. 다섯 번째 1. 여섯 번째

 

- 중첩된 목록

두 칸을 들여 쓰거나 `TAB`을 입력해서 중첩된 목록을 만들 수 있다. 반대로 내어 쓸 때는 `Shift+TAB`을 입력한다.

1. 첫 번째 목록     1. 첫 번째의 첫 번째 목록     1. 첫 번째의 두 번째 목록 1. 두 번째 목록     - 두 번째의 순서 없는 목록     - 두 번 중첩된 순서 없는 목록         - 몇 번이고 중첩할 수 있습니다. 1. 세 번째 목록

 

 

구분선, 수평선 만들기

------------

 

 

강조

**굵게** 또는 *기울여서* 글을 강조할 수 있다. 글 앞/뒤에 `*`나 `_`를 1번(기울게) 혹은 2번(굵게)을 입력하여 감싸면 된다.

**굵게** *기울임*

 

 

취소선

문구나 문장의 앞 뒤를 '~~'으로 감싸면 취소선을 표시할 수 있다.

~~취소선 테스트~~

 

 

링크

화면에 표시할 글은 '[]'(대괄호)로 감싸고, 이동할 주소에는 `()`(괄호)를 감싸서 입력하면 자동으로 링크를 생성할 수 있다.

컴공생의 다이어리(computer-science-student.tistory.com/)

 

 

m.blog.naver.com/jooeun0502/221956294941

[Git, 깃] README.md 작성하는 방법, 예시 | markdown (마크다운) 사용법, 문법

hack-jam.tistory.com/26

[Markdown] 웹 개발자를 위한 README.md 작성법

docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax

Basic writing and formatting syntax - GitHub Docs

dooray.com/htmls/guides/markdown_ko_KR.html

Markdown Help