VS Code 와 MD (Mark Down) 활용
MD 파일은 마크다운 (Mark Down)의 약자입니다. 읽기도 쓰기도 쉬운 문서 양식을 지향합니다.
저희 개발자들이 많이 쓰는 GitHub 에서는 기본적으로 README.md 파일을 첫페이지로 표시하기 때문에 MD 파일을 잘 꾸며주면 좀더 친화적인 저장소 설명이 될 수 있습니다. 허나 MarkDown은 표준은 아니기 때문에 GitHub가 지키는 MD파일 규칙을 알고 작업하시는게 좋습니다. GitHub는 기본 MD파일의 변형판인 Github-Flavored Markdown을 따르고 있습니다. 다음의 링크를 클릭하면 해당 규칙에 대한 좀 더 많은 정보를 볼 수 있습니다.
https://docs.github.com/en/get-started/writing-on-github
Writing on GitHub - GitHub Docs
Getting started with writing and formatting on GitHub
docs.github.com
만약 VS Code를 사용하고 계신다면 해당 툴에서는 기본적으로 MD 파일 미리보기를 지원합니다.
VS Code에서 MD 파일을 여시고, 문서 페이지 오른쪽 상단에 존재하는 위의 미리보기 버튼을 클릭하시면 하단과 같이 MD 파일이 양식에 맞춰 보이는 것을 확인할 수 있습니다.
MD 파일에서 간단한 아이콘 같은 건 이모지를 사용하는 것도 괜찮은 것 같습니다. 저도 이모지를 다 외우고 쓰지 못하기 때문에 필요 것들을 찾아서 쓰는데 제가 찾다가 보았던 참고할 만한 다른 분의 사이트 하나 알려드립니다. 잘 정리하신 것 같습니다.
[MarkDown] 📚 Emoji 이모티콘 사용하는 방법
마크다운 Emoji 이모티콘 마크다운을 이용해 이모티콘을 표현가능 하다. 깃허브도 문제없이 적용가능 하다. 마크다운 문법에 : : 사이에 이모티콘명을 넣으면 자동으로 인식된다. :rocket: GitHub suppo
inpa.tistory.com
하지만 VS Code 에서 이모지를 한번 써 보면 다음과 같이 제대로 이모지의 표시가 되지 않는 것을 보실 수 있습니다.
VS Code에서 이모지를 쓰려면 확장을 설치해 주셔야 합니다. 저는 Markdown Emoji 확장을 쓰고 있습니다. Ctrl+Shift+X를 누르셔서 Extentions로 진입 후 해당 이름을 검색하셔서 설치해 주시면 됩니다. 물론 더 좋은 것이 있어보이면 다른 걸 사용하셔도 됩니다.
설치 후에 미리보기를 보면 다음과 같이 제대로 이모지가 표시됨을 볼 수 있습니다.
또한 저는 VS Code에서 Markdown 스타일이 GitHub 좀 다르게 표시되어 Markdown Preview Github Styling 확장도 추가로 설치하였습니다. 사실 이것도 같지는 않으나 조금 더 나은 편이긴 해서 깔았습니다.
다음은 마크다운의 인용문을 이용한 미리보기 테스트한 결과 입니다. 이걸 쓴다고 편집 기능이 좀 더 나아지는 것은 아니니 취향에 따라 사용 여부를 결정하시면 될 것 같습니다.
