Tech

[Git] Readme 작성법

lonnie(동현) 2021. 2. 2. 23:13

1. 제목

: 제목을 정할 때는 '#'을 이용해서 강조해준다. #의 개수가 많을수록 더 작은 크기의 text를 반환한다. 


title code 예시

위의 코드를 출력하게 되면 아래와 같이 나타난다.


title code 출력 화면


2. 코드 블럭

: code block을 만들 때는 ` 를 사용하여 만들 수 있다. ``` ( ` 3개 )와 ```( ` 3개 ) 사이에 code block 시키고 싶은 text를 입력해주면 된다.


code block code 예시

위의 코드를 출력하게 되면 아래와 같이 나타난다.

code block 출력 화면

만약 문법이 있는 언어를 코드 블록에 넣고 싶다면 시작 부분 ``` 뒤에 해당하는 언어를 표시해주면 된다.

예를 들어, python 문법을 사용하고 싶다고 가정해보자. 그 경우는 아래와 같다.

프로그래밍 언어 문법을 출력 code 예시

위의 코드를 출력하게 되면 아래와 같이 나타난다.

python 언어 문법 출력 화면


3. blockquote(인용문)

: 인용문을 사용할 때는 >를 사용하여 만들 수 있다. 예를 들어, 아래의 코드를 보자.


blockquote code 예시

어떤 결과가 나올까? 위의 코드의 경우에는 겹쳐지면서 한 줄로 묶이는 것을 볼 수 있고, 아래의 코드의 경우에는 겹쳐지긴 하나 각자의 줄을 갖는 것을 볼 수 있다.

blockquote 출력 화면


4. 숫자 목록

: 숫자는 순서대로 출력된다. 아래의 코드를 살펴보자.


숫자 순서 예시 code

위의 코드는 어떻게 출력될까? 숫자를 아무리 뒤죽박죽으로 해놔도 1, 2, 3, 4 순서로 번호가 매겨진다.

숫자 순서 출력 화면


5. 순서 없는 목록 출력

: +, *, - 총 3가지 기호를 통해서 글머리 기호를 만들 수 있다. 아래의 코드를 보자.


목록 출력 code 예시

위의 코드를 출력하게 되면 아래의 결과를 갖게 된다. 출력 결과는 동일 하나 소속이 다르게 출력되는 것이다.

목록 출력 화면


6. 구분선

: 구분선을 만들기 위해서는 ---( - 3개 이상)을 사용한다. 아래의 코드를 보자.


구분선 code 예시

아래와 같이 3개든 그 이상이든 똑같은 구분선을 만들어주는 것을 볼 수 있다.

구분선 출력 화면

728x90
반응형