개발자라면 마크다운 언어를 자주 사용하게 됩니다
주피터 노트북, 구글 코랩에서도 코드를 문서화하는 것처럼 사용할 수 있고
가장 중요한 깃허브에서 프로젝트 소개 등의 페이지에 자주 사용됩니다
그래서 제가 마크다운 페이지를 작성할 때 주로 찾아보거나 사용하는 것들을 정리해보았습니다
1. 웹 에디터를 사용해라 (StackEdit)
짧고 간단한 내용만 작성한다면 따로 에디터를 사용할 필요는 없겠지만
프로젝트 소개 및 설치 안내 등의 긴 내용을 작성해야 한다면,
별도의 에디터를 사용하는 것이 훨씬 편리합니다
깃헙에서도 프리뷰로 제공하기는 하지만
마크다운이 적용된 모습을 확인하기 위해서는 매번 버튼을 클릭해봐야하기 때문에 좀 불편할 수 있습니다
그래서 저는 대부분의 내용은 웹 에디터를 사용해서 작성하고
어느정도 작성한 뒤에 복사+붙여넣기를 이용하는 편입니다
StackEdit
stackedit.io
링크는 다음과 같습니다
이와 같이 한 페이지에서 마크다운이 어떻게 적용되는지 바로 확인할 수 있기 때문에
마크다운을 사용하여 페이지를 작성할 떄 매우 유용합니다
2. 문법을 완벽하게 외울 필요는 없다
마크다운을 사용하여 페이지를 자주 작성한다고 해도,
모든 문법을 정확하게 매번 다 기억하기는 어렵습니다
자주 사용하는 것들은 금방 외우겠지만
그렇게 자주 사용하지 않는 이미지 삽입이나, 링크 삽입, 코드 블럭, 테이블 등은 까먹기가 쉽죠
물론 위에서 소개한 웹 에디터를 사용하면
에디터가 자동으로 삽입해주기 때문에 이 문제도 어느정도 해결 가능합니다!
하지만 에디터에서도 자신이 원하는 바에 따라서 딱 맞춰서 지원하지 않기 때문에
문법에 맞춰서 직접 수정해야하는 경우가 생길 수밖에 없습니다
그럴때는 역시 찾아보고 하는 것이 제격!
이를 위해서 제가 자주 참고하는 페이지 링크를 걸어놓겠습니다 :)
https://gist.github.com/ihoneymon/652be052a0727ad59601
마크다운(Markdown) 사용법
마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.
gist.github.com
https://heropy.blog/2017/09/30/markdown/
MarkDown 사용법 총정리
마크다운(MarkDown)에 대해서 알고 계신가요?파일 확장자가 .md로 된 파일을 보셨나요?웹 개발을 하면서 아마 README.md라는 이름의 파일을 한 번은 보셨을텐데, ...
heropy.blog
3. 무난하게 템플릿을 사용해도 좋다
사실상 매번 독창적이고 센스있고 필요한 정보들을
일목요연하게 정리해놓은 페이지를 작성하는건 생각보다 어려운 일입니다 . . 😂
그래서 사실 본인의 목적에 따라서
이미 사람들이 예쁘게 세팅해놓은 템플릿을 가져다쓰는 것이 더 좋을 수도 있습니다
하단에 제가 자주 참고하는 README 템플릿 링크를 걸어놓겠습니다
내가 좋은 문서를 쓰기 위해서는
이미 잘 쓰여진 문서를 많이 참고하는게 중요할 것 같습니다 :)
'Dev > TOOLS 도구' 카테고리의 다른 글
| [Git&GitHub] Git & GitHub 관련 개념 총정리 2탄 - 응용편 (0) | 2023.04.04 |
|---|---|
| [Git&GitHub] Git & GitHub 관련 개념 총정리 (1) | 2023.03.26 |
| [Git&GitHub] 원격저장소 생성 | 원격저장소에 커밋 올리기 | 원격저장소에서 로컬저장소에 커밋 내려받기 (0) | 2022.03.07 |
| [Git&GitHub] Git 설치 | 로컬저장소 생성 | git 기본 명령어 (0) | 2022.03.07 |
| [Git&GitHub] 버전 관리를 위한 시스템, Git & GitHub (0) | 2022.03.07 |
