9편. Markdown Style Guides

목차

1. 스타일 가이드에 관하여
2. 마크다운 스타일 가이드

---

스타일 가이드에 관하여

모든 프로그래밍 작업에서는 소스 코드의 전체 량이 커질 수록 복잡성이 높아지고, 그 코드를 읽고 이해하는 데에 어려움이 발생한다. 프로그래밍 하는 사람이 자기 혼자 공부하듯이 작성하는 코드라면 크게 문제가 없을 것이나, 회사 단위/팀 단위로 함께 소스 코드를 작성하고, 공유하고, 또 협업해야 한다면 해당 작업에 참여한 많은 프로그래머들이 이해할 수 있는 형태로 소스 코드를 작성해야 여러 문제를 줄일 수 있고, 작업 속도를 증가시킬 수 있다. 이를 위해 대다수의 규모가 있는 소프트웨어 개발 회사들은 “코딩 표준”, “스타일 가이드”라는 걸 개발하곤 한다.

Markdown의경우 여러 회사의 스타일들을 공부해 보았으나, 딱히 특별한 스타일 가이드를 제공하기 보다는 ‘마크다운은 대충 이렇게 사용하시면 된답니다’ 정도의 가이드를 제공하고 있었다. 그도 그럴 것이 Markup 언어는 프로그래밍 언어가 아니며, 그 자체로 Style을 표현하는 언어이기 때문에 어쩌면 당연한 듯 하다. 그래서 검색한 결과 중 대략적으로 좀 큰 회사들이 발표하였거나, 필자에게 도움이 될만한 스타일 가이드를 모아 보았다.

---

마크다운 스타일 가이드

• README 마크다운 참고 자료

  • 「스타일 가이드」라기 보다는 참고자료에 가깝지만, 그다지 똑똑하지 않은 필자로서는 영 외우기 싫은 어려운 내용이라 따로 자료를 링크해 두었다.
  • https://www.makeareadme.com/
  • https://www.quantumdl.com/entry/Github-READMEmd-작성법
  • https://happybono.wordpress.com/2018/01/03/tip-markdown-을-이용한-readme-문서-작성법/
  • https://brownbears.tistory.com/233

• 깃헙 마크다운 스타일 가이드

  • https://guides.github.com/features/mastering-markdown/
  • https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax

• 깃랩 마크다운 스타일 가이드

  • https://about.gitlab.com/handbook/markdown-guide/

• 구글 마크다운 스타일 가이드

  • https://google.github.io/styleguide/docguide/style.html

• 아틀라시안 비트버킷 마크다운 스타일 가이드

  • https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html

• 티스토리 마크다운 스타일 가이드

  • 기본적으로 GFM을 따라가겠다는 티스토리의 마크다운 문법 설명
  • https://tistory.io/entry/티스토리-글쓰기-가이드-마크다운문법

알림 : 위 링크들은 2021년 2월 기준으로 작성하였으므로, 작동하지 않는 링크가 있는 경우 검색하여 찾아주시기를 바란다.