블로그로 돌아가기
markdown 2025-02-20

마크다운: 개발자의 필수 작성 도구

이 종합 가이드로 문서화, README 파일, 기술 문서 작성을 위한 마크다운 구문을 마스터하세요.

마크다운은 2004년 John Gruber가 만든 경량 마크업 언어입니다. 개발자 문서, README 파일, 기술 문서 작성의 표준이 되었습니다.

왜 마크다운인가?

  • 간단한 구문: 배우기 쉽고, 원본 형태에서도 읽기 쉬움
  • 이식성: 일반 텍스트 파일은 어디서나 작동
  • 광범위한 지원: GitHub, GitLab, Stack Overflow, Notion 등
  • 버전 관리 친화적: 텍스트 diff가 깔끔하고 의미 있음

필수 구문

제목

제목 1

제목 2

제목 3

텍스트 서식

굵게 또는 __굵게__

기울임 또는 _기울임_

~~취소선~~

인라인 코드

링크와 이미지

[링크 텍스트](https://example.com)

![대체 텍스트](image.png)

목록

- 비순서 항목

  • 다른 항목

1. 순서 항목

2. 다른 항목

코드 블록

트리플 백틱과 선택적 언어 식별자를 사용합니다.

테이블

| 열 1 | 열 2 |

|-----|-----|

데이터 1데이터 2

좋은 README 파일 작성하기

좋은 README에는 다음이 포함되어야 합니다:

1. 프로젝트 이름과 설명

2. 설치 방법

3. 코드가 포함된 사용 예제

4. 설정 옵션

5. 기여 가이드라인

6. 라이선스 정보

마크다운 미리보기 도구로 마크다운을 실시간으로 미리 볼 수 있습니다.