By name: markdown-guide description: Markdown 문서 작성 시 일관된 스타일과 가독성을 위한 가이드 tags: [markdown, writing, documentation]
Markdown Guide
목적
Markdown 문서 작성 시 일관된 스타일을 유지하고 가독성을 높입니다.
기본 규칙
한 줄에 한 문장
각 문장은 별도의 줄에 작성합니다. 한 줄에 여러 문장을 담지 않습니다. 이렇게 하면 diff 확인과 버전 관리가 용이합니다.
# 좋은 예
이것은 첫 번째 문장입니다.
이것은 두 번째 문장입니다.
# 나쁜 예
이것은 첫 번째 문장입니다. 이것은 두 번째 문장입니다.
제목 계층
제목은 순차적으로 사용합니다. H1은 문서당 하나만 사용합니다.
# H1 - 문서 제목
## H2 - 주요 섹션
### H3 - 하위 섹션
빈 줄 규칙
제목 앞뒤로 빈 줄을 넣습니다. 코드 블록 앞뒤로 빈 줄을 넣습니다. 목록 앞뒤로 빈 줄을 넣습니다.