Github README file 작성하는 법 (markdown 사용법)

깃허브 프로젝트에 첫 Readme 파일을 작성해보았다 ><

Git에서 README.md 파일을 작성할 때는 마크다운 형식을 사용한다. 

 

● Markdown이란?

텍스트 기반의 마크업 언어로, 서식이 있는 문서를 작성하는 데 사용되며 비교적 문법이 쉽고 간단하다. HTML 등 서식 문서로 쉽게 변환되기 때문에 README 파일이나 온라인 게시물 등에 많이 사용된다. - 위키백과

 

제목 작성하기

# 큰 타이틀

## 중간 타이틀

### 작은 타이틀

 

인용구

> 를 사용해 인용구 처럼 block quote을 넣을 수 있다. 

>프로젝트 한줄설명

 

글머리 기호

순서가 없는 목록을 출력할 때에는 +, *, - 이렇게 총 3가지의 기호가 동일한 출력을 불러온다. 

* 토마토
- 오이
+ 감자

 

코드블럭

``` 로 텍스트를 감싸주면 코드블럭으로 보여줄 수 있다.

```
pod 'googleapis', :path => '.'
pod 'Alamofire'
```

``` swift 이렇게 언어를 함께 써주면 언어 색깔에 맞춰서 코드블럭을 생성할 수도 있다. 

 

강조

 

 

이미지 파일 넣기

해당 Repository에 [Isuues - New issue] 들어가서 원하는 사진을 드래그 앤 드랍 해주면 업로드가 된다. 

![파일 이름](https://이미지 주소) 

형식으로 업로드가 되면 이 전체를 복사해와서 Readme 파일에 넣어주면 된다. 

+ 이 방식으로는 이미지 크기 변경은 불가하다고 한다. 아예 이미지의 HTML 링크를 따로 생성하여 불러오면 크기 조절이 된다고 하는데, 나는 그냥 원본 이미지를 resizing 해서 넣어주었다.