개요

Github와 Bitbucket 그리고 Gitlab은 이 README.md 파일을 이용해 저장소의 메인을 보여줍니다.그리고 javascript의 Documentation툴인 JSDoc은 버전 3부터 README.md 파일을 읽어서 문서의 index를 장식합니다. 이렇게 다방면으로 유용하게 쓰이는 README.md 파일은 마크다운 형식으로 작성됩니다. 마크다운은 일련의 작성 규칙(Markdown cheatsheet)이 있습니다.
README.md 파일을 작성하다보면 어떻게 페이지에서 보여질까 궁금할때가 많습니다. 웹스톰의 마크다운 플러그인을 이용하면 간단히 이 궁금증을 해소할 수 있습니다.
 

플러그인 설치

웹스톰의 Plugin 창으로 가서 “markdown”을 검색하여 설치합니다.
스크린샷 2014-08-13 오후 10.03.44
 

README.md 작성

이제 README.md를 작성하면 마크다운 문법에 맞춰 신텍스 하일라이팅 됩니다.
스크린샷 2014-08-13 오후 10.04.52
 

README.md 프리뷰

하단의 Preview 탭을 클릭하면 현재 작성된 마크다운 문서의 데모를 볼 수 있습니다.
스크린샷 2014-08-13 오후 10.07.05
 
마크다운 플러그인을 이용하면 별도의 마크다운 에디터 없이도 간단하게 IDE 내에서 해결할 수 있습니다. 마크다운 플러그인을 사용해서 조금 더 편리하게 README.md 파일을 작성하시길 바랍니다.

카테고리: Research

UYEONG

사케와 힙합을 즐길 줄 아는 프론트엔드 개발자입니다.

0개의 댓글

댓글 남기기

이메일은 공개되지 않습니다. 필수 입력창은 * 로 표시되어 있습니다