[마크다운(MarkDown)/README.md] github에서 README.md 파일(마크다운형식) 작성법

[마크다운(MarkDown)/README.md] github에서 README.md 파일(마크다운형식) 작성법

 

github통하여 코드 버전관리를 하다보면, 점점 코드사용법 혹은 메뉴얼의 필요성을 느끼게된다.

그로인해 github에서는 README.md라는 MarkDown 포맷의 메뉴얼을 기본템플릿으로 지원한다.

 

[README]

github에서 제공하는 가이드라인 ,메뉴얼, 안내문

 

 

MarkDown형식을 이용하다보면 굉장히 편리하게 다양한 내용을 깔끔하게정리 할 수 있다.

다른 블로그들에서도 손쉽게 정리가 되어있지만, 여기서는 필요한 요소들을 매우 간단하게 정리해보겠다.

 

[마크다운(MarkDown)]

간단한 키워드로 다양하게 문서를 작성 할 수 있는 메타파일을 이야기하며 md 형식의 확장자를 지닌다.(README.md)

 

 

최대한 한눈에 들어오도록 간략하게 정리하였다.

 

저정도면 사용한다면 아주 훌륭한 메뉴얼을 만들 수 있다.

아래는 내가 작성한 README.md를 공유하니, 참고하길 바란다.

https://github.com/gofogo2/nest-api-project-templete/blob/master/README.md

GitHub - gofogo2/nest-api-project-templete

 

#github #markdown #readme #md #readme.md #메뉴얼 #guide #가이드 #manual #문서 #설명서 #git #commit