- README.md 이란?
- README 문법
-
- 제목 (header)
- 줄바꿈 (line break)
- 수평선 (horizontal rule)
- 글자 강조 (emphasis)
- 목록 (list)
- 인용문 (block quote)
- 표 (table)
- 코드 블록 (code block)
- 내부문서 이동
- 외부링크 이동
# README.md 이란?
- GitHub 등 코드 호스팅 서비스에서 프로젝트 정보가 담긴 파일
- 프로젝트 개요, 설치 방법, 사용법, 기여 방법, 라이센스 정보 등 프로젝트의 정보를 문서화하여 다른 개발자나 사용자에게 프로젝트에 대해 알려줄 수 있다
- ReadMe.md 의 .md 확장자는 MarkDown의 약자이며, ReadMe 파일은 마크다운 문법을 사용한다
# README 문법
# 제목 (header)
- 1단계(큰)에서 6단계(작은)까지 표현할 수 있으며 # (Crosshatch)으로 구분한다
- # 이 적을수록 큰 단계(글자)로 표현된다
# 제목 1단계
## 제목 2단계
### 제목 3단계
#### 제목 4단계
##### 제목 5단계
###### 제목 6단계
# 줄바꿈 (line break)
- 엔터 한번은 줄바꿈이 적용되지 않는다
- 엔터 전 행의 띄어쓰기 두번 혹은 두번 엔터해야 줄바꿈이 인식된다
- 혹은 줄바꿈 태그<br/> 를 사용해도 된다
띄어쓰기 한번
띄어쓰기 한번
***
띄어쓰기 두번
띄어쓰기 두번
***
엔터 한번
엔터 한번
***
엔터 두번
***
엔터 두번
***
라인 1<br>라인 2
# 수평선 (horizontal rule)
- - (Hyphen) 혹은 * (Asterisk) 기호를 3번 이상 작성
수평선
---
수평선
***
# 글자 강조 (emphasis)
- 굵게 : * (Asterisk) 기호 혹은 _ (Underscor) 기호 두번 양쪽 작성
- 이텔릭 : * (Asterisk) 기호 혹은 _ (Underscor) 기호 한번 양쪽 작성
- 굵기 + 이텔릭 : * (Asterisk) 기호 혹은 _ (Underscor) 기호 세번 양쪽 작성
- 취소선 : ~ (Tilde) 기호 두번 양쪽 작성
- 밑즐 : 태그 <u> 이용
- 색강조 : ` (Grave) 기호 한번 양쪽 작성
**굵은 글씨** or __굵은 글씨__
*이텔릭* or _이탤릭_
***굵고 이텔릭*** or ___굵고 이텔릭___
~~취소선~~
<u>밑줄</u>
`색강조`
# 목록 (list)
- 순서가 필요한 리스트 : 1. (자동으로 인덱싱 된다)
- 순서가 필요하지 않는 리스트 : * (Asterisk), +(Plus Sign), - (Hyphen)
1. 순서가 필요한 목록
1. 순서가 필요한 목록
1. 순서가 필요한 목록
1. 순서가 필요한 목록
1. 순서가 필요한 목록
- 순서가 필요하지 않은 목록
- 순서가 필요하지 않은 목록
- 순서가 필요하지 않은 목록
- 순서가 필요하지 않은 목록
# 인용문 (block quote)
- > (Greater than) 기호를 사용하며, 반복 사용하면 중첩된다
> 인용문장
>> 중첩된 인용문
>>> 중첩된 인용문 2
# 표 (table)
- 테이블 헤더와 바디는 - (Hyphen)으로 구분한다.
- : (Colons) 기호로 내부 텍스트를 정렬한다 ( :-- 왼쪽 정렬, :--: 가운데 정렬, --: 오른쪽 정렬)
- 열은 | (Vertical Bar) 기호로 구분, 행은 줄바꿈으로 구분한다
| th---1 | th2--- | th---3 |
| :-- | :--: | --: |
| td | td | td |
| td | td | td |
| th---1 | th2--- | th---3 |
| - | -- | ---- |
| td | td | td |
| td | td | td |
# 코드 블록 (code block)
```
<div>
<p>Hello, J!</p>
</div>
```
# 내부문서 이동
- 클릭하면 해당 페이지의 원하는 위치로 화면이 이동할 수 있다 (스크롤 이동)
- [링크](#이동위치) : [보여지는 텍스트]를 클릭하면 (#마크다운-문법)의 위치로 이동한다
[보여지는 텍스트](#마크다운-문법)
...
# 마크다운 문법
- 작성 방법
- 띄어쓰기는 - (Hyphen) 기호로 연결한다
- 영어는 모두 소문자로 작성한다
- 소괄호, 이모지, 특수문자는 모두 제거한다
- 이동할 위치는 # (Crosshatch) 기호로 제목으로 구분되어 있어야 한다
- ex : 마크다운 문법(Markdown Grammar) ▷ [링크](#마크다운-문법markdown-grammar)
# 외부링크 이동
- text 에 링크 걸기 : [링크](url)
- url 노출하며 링크 걸기 : <url>
[Naver Move](https://www.naver.com/)
<https://www.naver.com/>
