스파르타 내일배움캠프/Today I Learned

Today I Learned - Day 33 [Readme에 대하여]

불면증 도사 2024. 10. 30. 21:18

Git을 다루다 보면 자주 맞닥뜨리게 되는 거이 바로 Readme 이다.

Readme는 Git hub에서 프로젝트의 첫 페이지에 해당하는 요소로, 다르게 말하면 이것 부터 잘 적어야지 안그러면 Git을 보는 사람들이 해당 프로젝트에 대해서 이해하기가 힘들어진다.

 

그나저나, Readme의 내용에 대해서는 프로젝트의 성격에 따라서 크게 달라지기 때문에, 이에 대해서 서술하는 것은 일단 넘겨두고, 금일은 Readme의 문법에 대해서 정리 해 볼까 한다.

마크다운 문법

마크다운은 마크업 언어의 일종으로, 읽기 쉽고 쓰기 쉬운 방식을 지향하는 문서 작성용 언어다.

마크 다운 자체가 다양한 곳에서 쓰이다 보니, 알아두면 이래저래 쓰일 가능성이 높다.

확장자로는 .md나 .markdown 를 사용한다.

 

문단 제목

# 1단계 제목
## 2단계 제목
### 3단계 제목


라인의 제일 앞에 #을 넣으면, 해당 라인을 문단의 제목으로 사용한다.

#의 갯수에 해당하는 단계가 형성되기 때문에 간단하게 포함 관계를 형성할 수 있다.

 

강제 개행

마크다운은 기본적으로 강제개행을 인식하지 못하기 때문에, 강제 개행을 할 수 있는 서식을 작성해야 한다.

공백을 2개 연속으로 넣거나 역슬래시(\)를 넣으면 강제개행이 된다. <br/>를 쓰는 방법도 있다.

 

또한, 한 줄을 비워서 작성하면 그 비워진 줄을 기준으로 문단끼리 분리된다.

 

글머리 기호 목록

* 목록 1
  * 목록 1-1
  * 목록 1-2
* 목록 2
[* 대신 -이나 +도 쓸 수 있다. 복합 사용도 가능.]

라인의 제일 앞에 *이나 -, +를 입력하면 글머리 기호 목록이 된다.

*의 앞에 공백을 2칸 넣으면, 2칸 당 1단계 씩 하위 목록을 만들게 된다.

 

숫자 목록

1. 첫 번째 목록
2. 두 번째 목록
3. 세 번째 목록

앞에 있는 숫자와 .(온점)이 목록의 순번으로 사용된다.

전체적으로 글머리 기호 목록과 유사하다. 라인의 앞에 공백을 2칸 넣어서 단계를 조절할 수 있다는 것도 동일.

 

인용

> 인용 1
>> 인용 2
>>> 인용 3

사실 단순한 글상자를 만드는 것에 가깝다.

> 의 수에 따라서 포함 관계가 달라진다.

 

글자 형태

Bold = ** text **
Italic = 'text'
취소선 = ~~text~~

Bold = 굵게  /  Itealic = 기울임꼴

 

코드 블럭

~~~
코드 블럭
~~~

코드블럭의 위치에 존재하는 내용을 감싸는 글상자를 추가한다.

위의 ~~~의 오른쪽에 언어 종류를 적으면 해당 언어 강조도 가능하다.

 

인라인 코드

~인라인 코드~
<code> 인라인 코드 </code>

2개 모두 같은 결과로, 문단 내에서 배경색을 입혀서 강조처리 한다.

 

수평선

* * *
***
*****
------------------------------------------
<hr>

5가지 모두 수평선을 그리는 함수다.

 

링크

[text](URL)

URL의 주소로 가는 text 링크를 형성한다.

추가로, 상단의 문단 제목을 이용해서 같은 Readme 안에서의 링크도 가능하다.

 

이미지 삽입

Git hub는 이미지를 직접 끌어다 두어서 삽입할 수 있다.

대신 크기를 조절하려면 HTML 문법으로 변경해야 한다.

이미지 삽입 + 크기 조절을 합하면 문법은 다음과 같다.

![파일명](디렉토리)

<img src = "디렉토리" width = "너비" height = "높이">

 

표

| 헤더 1 | 헤더 2 | 헤더 3 | 헤더 4 |
|---|:---|---:|:---:|
|내용 1-1 | 내용 1-2 | 내용 1-3 | 내용 1-4 |
|내용 2-1 | 내용 2-2 | 내용 2-3 | 내용 2-4 |
|내용 3-1 | 내용 3-2 | 내용 3-3 | 내용 3-4 |
|내용 4-1 | 내용 4-2 | 내용 4-3 | 내용 4-4 |

헤더와 내용 사이에 3개 이상의 -(하이픈)으로 구분된 선을 명시해야 함에 주의하자.

추가로, -으로 이루어진 라인에 :(콜론)을 이용해서 정렬을 변경할 수 있다.

상단의 예시에서는 [1은 정렬 안함 | 2는 좌측 정렬 | 3은 우측 정렬 | 4는 중앙 정렬]이다.

이상으로, Readme에서 쓰이는 마크다운 문법에 대해서 알아보았다.

솔직히 말해서 문법은 익숙해 지는 것이 가장 중요하다. 그러니 자연스럽게 작성할 수 있도록, 프로젝트를 진행하면서 작성하는 데에 익숙해지는 것이 중요할 것이다.