[Git] README

Aiden·2024년 2월 19일
0

Git

목록 보기
13/13
post-thumbnail

사용목적

Git REAMME.md 파일에 대한 Git 내용입니다.

README.md

README.md 파일은 프로젝트에 대한 설명, 사용방법, 라이센스, 설치법과 같은 부분에 대해 기술하는 파일입니다.

MARKDOWN

README.md 파일은 MARKDOWN 문법으로 사용 가능합니다.

HEADER (#)

제목을 표시하기 위한 문법으로 #을 사용합니다. (#은 6개까지 사용 가능합니다.)

# HEADER 1
## HEADER 2
### HEADER 3
#### HEADER 4
##### HEADER 5
###### HEADER 6

실제 표시)

HEADER 1

HEADER 2

HEADER 3

HEADER 4

HEADER 5
HEADER 6

BLOCKQUOTE (>)

인용문을 표시하기 위한 문법으로 >를 사용합니다. (>이 늘어나면 Depth가 깊어집니다.)

> BLOCKQUOTE (> BLOCKQUOTE)

>> BLOCKQUOTE (>> BLOCKQUOTE)

실제 표시)

BLOCKQUOTE (> BLOCKQUOTE)

BLOCKQUOTE (>> BLOCKQUOTE)

LIST

숫자 목록

숫자 목록은 number. 의 형태로 사용할 수 있습니다.

1. LIST 1
2. LIST 2

실제 표시)
1. LIST 1
2. LIST 2

순서 없는 목록

순서 없는 목록은 *, +, -를 사용합니다. (TAB 시 상위 목록에 속해집니다.)

* LIST 1
- LIST 2
+ LIST 3

실제 표시)

  • LIST 1
  • LIST 2
  • LIST 3

CODEBLOCK

CODEBLOCK은 코드를 표현하기 위한 MARKDOWN 문법입니다.

한 줄로 표시

``` CODEBLOCK```
<code> CODEBLOCK </code>

실제 표시)
CODEBLOCK
CODEBLOCK

넓게 표시

"```
CODEBLOCK
```"
<pre><code> CODEBLOCK </code></pre>

실제 표시)

CODEBLOCK
 CODEBLOCK 

HORIZON LINE

수평선을 표시하는 문법으로 ***, ---으로 사용합니다.

***
---

실제 표시)



링크 주소 표시

링크 주소를 그대로 표시하는 방법으로 (), <> 내 URL을 넣어 사용합니다.

(https://velog.io)
<https://velog.io>

실제 표시)
https://velog.io
https://velog.io

텍스트 내 링크 표시

텍스트에 링크를 적용하는 방법으로, [] 안에 텍스트, ()내 URL을 넣어 사용합니다.

[Velog](https://velog.io)

실제 표시)
Velog

TEXT STYLE

굵은 텍스트

텍스트를 굵게 표현하는 문법입니다.

**TEXT**

__TEXT__

실제 표시)
TEXT
TEXT

기울임

텍스트를 기울여서 표현하는 방법입니다.

*TEXT*
_TEXT_

실제 표시)
TEXT
TEXT

취소선

텍스트에 취소선을 표시하는 방법입니다.

~~TEXT~~

실제 표시)
TEXT

IMAGE

이미지를 넣기 위한 문법입니다.

![대체텍스트](이미지주소)

![이미지 연습](https://velog.velcdn.com/images/bizpm_aiden/post/4352010b-5050-46ff-91ad-92120662f7eb/image.jpg)

실제 표시)
이미지 연습

profile
aiden

0개의 댓글