마크다운 ( Markdown )
개발 과정에서 문서화는 거의 필수적인 요소이다.
마크다운은 텍스트 기반 경량 마크업 언어로, 개발자들 사이에서 표준처럼 쓰이는 문서 작성 방식이다.
단순한 문법을 사용해 글자 강조 , 목록 , 표 , 링크 , 코드 블록 등을 손쉽게 표현할 수 있게 해준다.
GitHub , GitLab , 블로그 등에서 마크다운이 지원된다.
존 그루버 ( John Gruber ) 와 애런 슈워츠 ( Aaron Hillel Swartz ) 가 만들었다.
그루버는 마크다운으로 작성한 문서를 HTML 로 변환하는 Perl 스크립트도 만들었다.
다만 요즘에는 범용성이 높은 Pandoc 를 더 많이 사용한다.
마크다운의 장점
- 1. 간단하고 직관적인 문법
- # , - , * , ` 같은 기본 기호만 알면 사용 가능하다
- 별도의 툴이나 복잡한 UI 없이 메모처럼 쓰면서 문서화 가능하다
- 2. 플랫폼 호환성 높음
- GitHub , GitLab , Notion , Tistory , Velog , Obsidian , VS Code 등 대부분 지원한다
- .md 파일 하나로 다양한 환경에서 동일하게 표시된다
- 3. 개발 친화적
- 코드 블록 지원 , syntax hightlighting 가능
- README.md , 기술 문서 , 블로그 포스트에 최적
- 4. 버전 관리 용이
- 단순 텍스트 파일이므로 Git 으로 관리하기 쉽다
- 문서 협업 시 diff 비교도 명확하게 보여준다
- 5. 경량성과 가독성
- HTML 보다 훨씬 가볍고 쓰기 빠르다
- 사람이 직접 읽어도 이해하기 쉽고, 랜더링 결과도 깔끔하다
- 6. 확장성
- 기본 문법 외에 표, 체크박스 , 각주 같ㄴ은 확장 기능도 지원
- HTML 태그와 병행 가능
기본 문법
▼제목 ( Headers )
# 제목1 (H1)
## 제목2 (H2)
### 제목3 (H3)
#### 제목4 (H4)
##### 제목5 (H5)
###### 제목6 (H6)제목은 # 기호를 사용해 크기를 조절한다
# 이 많아질수록 글자 크기가 작아진다
제목 뒤에는 한 칸 띄워주는 게 일반적이다
▼텍스트 강조
**굵게** 또는 __굵게__
*기울임* 또는 _기울임_
~~취소선~~
`인라인 코드`굵게
기울임
취소선
인라인 코드
목록 ( Lists )
▼순서 없는 목록
- 항목 1
- 항목 2
- 하위 항목 2-1
- 하위 항목 2-2
- 항목 3
▼순서 있는 목록
1. 첫 번째
2. 두 번째
3. 세 번째
링크 & 이미지
▼링크
[링크 텍스트](https://devhochan.tistory.com/)
[링크 텍스트](https://devhochan.tistory.com/ "툴팁 텍스트")
▼이미지
코드 블록
▼인라인 코드
이것은 `인라인 코드 사용 예시` 입니다.
이것은 인라인 코드 사용 예시 입니다.
▼코드 블록
```
이것은 코드 블록 예시입니다
```이것은 코드 블록 예시입니다
표 ( Tables )
| 이름 | 과목 | 점수 |
|------|:----:|-----:|
| 호찬 | 수학 | 76 |
| 윤수 | 영어 | 95 |
| 향숙 | 과학 | 88 |
| 이름 | 과목 | 점수 |
| 호찬 | 수학 | 76 |
| 윤수 | 영어 | 95 |
| 향숙 | 과학 | 88 |
- 표는 파이프 ( | ) 문자로 열을 구분
- 두번째 줄의 ( --- ) 로 헤더와 본문을 구분한다.
- 마크다운 표는 : 위치로 정렬을 제어할 수 있다
- 왼쪽 ( :--- ) , 가운데 ( :---: ) , 오른쪽 ( ---: )
인용문
> 인용문이다.
>> 중첩 인용도 가능하다.
인용문이다.
중첩 인용도 가능하다.
구분선
---세 개 이상의 하이픈으로 구분선 가능
체크 리스트 ( GitHub Flavored Markdown )
- [x] 완료된 작업
- [ ] 진행 중인 작업
- [ ] 부가 업무 1
- [x] 부가 업무 2
- [ ] 대기 중인 작업- 완료된 작업
- 진행 중인 작업
- 부가 업무 1
- 부가 업무 2
- 대기 중인 작업
정리
마크다운은 배우기 쉽고 여러 플랫폼에서 호환된다.
개발 문서화와 협업에 최적화된 가볍고 효율적인 문서 작성 도구이다.
참고 자료
마크다운 공식 사이트
https://daringfireball.net/projects/markdown/
마크다운 문서를 HTML 로 변환하는 스크립트