깃허브 에서 README 부분을 깔끔하게 작성하려고 하는데, 다른사람들의 README는 예쁘고 깔끔한데 대체 어떻게 작성한거지? 하고 찾아보다가.. README.md 에서의 파일명 md가 Markdown의 약자인걸 알게되었다.
마크다운 작성법에 대해서는 여기 가 제일 깔끔하고 잘 설명되어있다.
위의 작성법을 보고 그대로 작성해도 깃허브 리드미 수정할때에
Preview changes 를 보면서 작성을 해도 좋지만, 바로바로 어떻게 적용이 되는지 보여주는 편집기를 추천하고자 한다.
Typroa
- 마크다운 문법에 맞춰 작성하면 서식이 바로 적용되어 보여진다.
- 마크다운 문법 뿐 아니라 기존의 잘 알려진 단축키를 통해서도 서식을 적용 할 수 있다.
- 무료
맥, 윈도우즈, 리눅스용 가능하다.
별다른 요구사항 없이 다운로드 하면 잘 받아진다.
이렇게 마크다운 문법을 작성하고 엔터를 누르면
바로 적용되어지는 모습을 확인 할 수 있다.
또한 README 에서 직접 수정할때 줄바꿈이 엔터키로 안되었었는데, Typora 에서는 엔터로 줄바꿈이 가능하다.
Ctrl + 1 ~ 6 : 제목 1 ~ 6
Ctrl + B : 굵게
Ctrl + I : 이탤릭체
Ctrl + U : 밑줄
Ctrl + K : 하이퍼링크
등 많은 단축키들을 통해 간단하게 작성이 가능하다.
위에 간단하게 몇개만 적어놓은 단축키 뿐만 아니라 상단에 본문, 서식 부분을 통해 보다 더 다양하게 글을 꾸밀 수 있다.
당연히 편집기 테마도 바꾸어줄 수 있다. 나는 지금 Night 모드를 적용 한 상태.
좌측하단을 누르면 내가 작성한 내용의 마크다운 소스도 확인 할 수 있다.
앞으로 README 작성할때 이 편집기를 많이 애용할것 같다. 😁