[Git] README.md 설정하기

이번엔 README.md 파일 작성하는 법을 알아보자

 

README.md 는 개발자가 이 프로젝트 또는 파일에 대한 설명을 적어놓는 곳이라고 생각하면 된다.

 

Github에서 자주 접하는데 들어가자마자 보이니 약간 프로젝트의 첫인상? 같은 느낌이다.

사람도 첫인상이 좋으면 호감이 생기는 것처럼 우리도 아끼는 프로젝트의 README.md를 잘 꾸며주자.

 

그럼 시작하기전에 README의 확장자인 .md가 무슨 뜻일까?

README는 markdown(마크다운언어) 라는 뜻이다.

마크다운언어는 마크업언어의 일종으로 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 빠르게 컨텐츠를 작성하고 직관적으로 인식할 수 있다.

Github에서는 기능을 더 추가한 Github-Flavored Markdown 을 사용한다. 

 

그래서 여기에도 문법이 존재한다.

아래 소개할 다양한 문법들로 README.md 파일을 잘 작성해보자

 

1. 제목

 

# 내용 으로 사용가능하다.

#을 많이 쓸수록 크기가 줄어든다.

6개까지 가능하다.

 

# 제목입니다
## 제목입니다

 

 

 

아니면 이렇게도 가능하다.

다른제목
===
작은다른제목
---

 

 

2. 개행 (줄내림)

마크다운은 기본적으로 강제개행(enter키 누르면 줄내림 되는것)을 인식하지 않는다.

개행을 하려면 띄어쓰기를 두번 하거나 역슬래시를 넣으면 된다. 

가독성 문제로 띄어쓰기는 권장하지 않는다.

치즈피자  
먹고싶다

치즈피자\
더\
먹고싶다

 

3. 목록

*이나 -로 목록 표시가 가능하다.

* 목록1
* 목록2
* 목록3
- 목록1
- 목록2

 

순서도 가능하다.

근데 앞에 숫자는 안 맞춰도 작동한다. 어차피 각 행이 HTML의 <li> 형태로 변환되어 정보가 사라지기 때문이다.

1. 1번
2. 2번
3. 3번
6. 4번
3. 5번

 

 

 

아래처럼 목록안의 목록도 가능하다.

 

* 목록
    * 목록
        * 목록
1. 목록
    1. 목록
    3. 목록
1. 목록
    1. 목록

 

4. 굵게와 기울기

** 이나 __ 로 감싸주면 굵은 글씨가 가능하다.

너만 **굵냐** 나도 __굵다__

 

*와 _를 하나씩 사용하면 기울여진 글자가 나오는데, 위의 기능과 같이 쓰면 둘 다 사용가능하다.

*기울게* _기울게_
***굵게기울게*** ___굵게기울게___

 

 

 

 

5. 코드

기본 마크다운과는 다르게 Github는 ``` 로 감싸기만하면 여러 줄까지 지원해준다.

위 ``` 옆에 프로그래밍언어를 쓰면 색깔도 나온다.

참 좋은 세상이다.

``` c
printf("Hello world!");
printf("Bye world!");
```

 

 

6. 인용문

 

> 을 사용하면 된다. 많이 쓰면 중첩된다.

 

> 피자에는
>> 치즈크러스트다
>>> 아니다 고구마무스다

 

 

 

 

 

7. 링크

 

[내용](링크)  내용을 클릭하면 링크로 이동한다.

 

[네이버](https://www.naver.com)

 

8. 이미지

 

 내용에 이미지 설명과 이미지 주소를 링크에 쓰면된다. 

이거 전체를 위 링크의 내용란에 넣고 링크를 설정해주면 이미지링크로도 사용가능하다.

 


 

❗ 그냥 내용에 특수문자를 사용하고 싶을 땐 앞에 \ 를 붙여주면 된다!

 

 

더 다양한 기능을 알고싶다면 아래 링크로!

 

추가 기능