본문 바로가기

기타

Github README 작성하기

readme.md (markdown)

레포지토리 데모를 꾸밀수 있다. 프로젝트, 소스코드에 대한 설명 등을 써주면 보기가 좋다.

 

▶ 작성 방법

github 페이지에서 작성할 수 있다.

Edit file 에서 작성을 하고, Preview changes 에서 미리 보기가 가능하다.

 

- 헤더 (#) 

h1 ~ h6 의 역할을 한다. (최대 6개까지 가능하며, 많이 붙을수록 작아진다.)

입력 글자의 앞에 #을 붙여 사용한다 . 일반적으로 #2개또는 3개를 사용하여 제목으로 쓴다.

 

- 리스트

리스트 형태를 사용할 수 있다. 입력 글자 앞에 *를 붙여준다.

*을 붙여작성하면 preview에 다음과 같이 나타난다.

 

- 인용구

인용구는 꺽쇠를 사용하여 해당 구문 앞에 붙여준다.

 

- 소스코드 블럭

```(언어)``` 안에 넣고자 하는 소스코드를 작성한다.

 

- 링크 작성

[]대괄호 안의 글씨에 uri 링크가 걸린다.

[해당주소](uri)

- 테이블 작성

테이블 형태를 아스키 코드로 표현한다

제목행(thead)와 내용행(tbody)을 구분해서 사용한다.

- 사진 첨부

Issues 탭에 들어간다.

new issue 버튼을 선택한다.

해당 이미지 파일을 마우스로 끌어온다.

끌어온 이미지 파일의 링크가 생성된다. 이 링크를 복사하여 작성중이던 Readme 파일에 붙여넣는다.

성공적으로 이미지 로드 완료

 

참고할 사이트

https://post.naver.com/viewer/postView.nhn?volumeNo=24627214

'기타' 카테고리의 다른 글

Git - 형상관리  (0) 2020.07.15