개발자라면 GitHub README, 기술 블로그(티스토리, 벨로그), 노션(Notion), 디스코드 등에서 마크다운(Markdown)을 매일 마주하게 됩니다. 마크다운은 텍스트에 간단한 기호를 붙여서 서식을 만드는 경량 마크업 언어입니다.
오늘은 가장 자주 쓰는 핵심 마크다운 문법을 깔끔하게 정리해 드립니다. 이 글 하나면 README 작성, 문제 없습니다!
1. 제목 (Header)
문서의 구조를 잡을 때 사용합니다. 샵(#)의 개수로 크기를 조절합니다.
# 제목 1 (가장 큼 - H1)
## 제목 2 (H2)
### 제목 3 (H3)
#### 제목 4 (H4)
2. 목록 (List) & 할 일 (Check Box)
순서 없는 목록: -, *, + 중 아무거나 사용하고 한 칸 띄웁니다.
- 코틀린 공부하기
- 블로그 글 쓰기
- 들여쓰기도 가능
순서 있는 목록: 숫자와 점(1.)을 사용합니다.
1. 첫 번째 할 일
2. 두 번째 할 일
할 일 목록 (Check Box): 대괄호 [ ]를 사용합니다. (Github 등에서 유용)
- [ ] 아직 안 한 일 (대괄호 안에 공백)
- [x] 완료한 일 (대괄호 안에 소문자 x)
- [ ] 아직 안 한 일
- [x] 완료한 일
3. 코드 블록 (Code Block) ✨
개발자에게 가장 중요한 기능입니다. 코드에 하이라이팅을 입혀줍니다.
인라인 코드: 문장 중간에 코드를 넣을 때 백틱(`) 하나로 감쌉니다.
- 사용법: 변수 'name'을 선언했습니다.
- 결과: 변수 name을 선언했습니다.
멀티라인 코드 블록: 백틱 3개(```)로 감쌉니다. 언어 이름(kotlin, java, python)을 뒤에 적으면 색상도 입혀집니다.
```kotlin
fun main() {
println(Hello Markdown!)
}
```
4. 강조 (Emphasis)
- 굵게(Bold): 별 두 개(**) 혹은 언더바 두 개(__)
- **강조**→ 강조
- 기울임(Italic): 별 한 개(*) 혹은 언더바 한 개(_)
- *기울임* → 기울임
- 취소선(Strikethrough): 물결 두 개(~~)
- ~~취소선~~ → 취소선
5. 인용문 (Blockquote)
다른 사람의 글을 인용하거나 설명글을 달 때 씁니다. > 기호를 사용합니다.
> 개발은 즐겁다.
> 코틀린은 재밌다.
6. 링크(Link)와 이미지(Image)
문법이 비슷하니 주의하세요! 이미지는 앞에 느낌표(!)가 붙습니다.
- 링크: [표시할 텍스트](링크 주소)
- 예: [Google](https://google.com)
- 이미지: 
- 예: 
마무리
마크다운은 익숙해지면 마우스로 서식을 지정하는 것보다 훨씬 빠르고 효율적입니다. 특히 README.md 파일을 예쁘게 꾸미면 프로젝트의 퀄리티가 달라 보입니다. 오늘 정리한 내용만 알아도 "문서 잘 쓰는 개발자" 소리를 들을 수 있을 거예요!
'Dev Log' 카테고리의 다른 글
| "코드는 완벽한데 왜 빌드가 안 될까?" 윈도우 개발자가 꼭 알아야 할 Gradle 트러블슈팅 (0) | 2026.01.07 |
|---|---|
| [IDE Tip] 테스트 실패 시 로그가 안 보인다면? (Gradle vs IntelliJ 설정) (0) | 2026.01.03 |
| UX 글쓰기 (feat. 애플) (1) | 2025.12.06 |
| [우테코 AN 8기] 프리코스 3주차 회고 | 로또 과제, 오픈미션이란? (0) | 2025.11.09 |
| 좋은 코드 구조는 어떠한 구조일까? | MVC 패턴, TDD (0) | 2025.11.02 |