개발 기본
마크다운(Markdown)
마크다운(Markdown)은 문서 구조를 간단한 텍스트 기호로 표현하는 문법입니다.
쉬운 설명
제목, 목록, 링크, 코드블록 같은 문서 구조를 간단한 텍스트 문법으로 쓰는 형식.
배경과 쓰임까지 이해하기
조금 더 자세히
마크다운(Markdown)은 문서를 간단한 텍스트 기호로 정리해서 쓰는 문법입니다. 보통 문서를 HTML처럼 복잡하게 쓰지 않고도 제목, 목록, 링크, 코드블록, 표 같은 구조를 표현하고 싶을 때 사용합니다. 예를 들어 `# 제목`, `- 목록`, `[링크](주소)`, ```코드블록``` 같은 방식으로 문서를 작성합니다.
README, Github(깃허브) 이슈, 블로그 글, 문서 사이트, PRD 초안, AI 작업 지시문에서 자주 만납니다. 사람이 읽기 쉽고 Git으로 관리하기 좋아 개발 문서에서 특히 많이 쓰입니다. 한마디로, 마크다운(Markdown)은 개발자와 AI가 함께 읽기 좋은 간단한 문서 문법입니다.
실제로는 이렇게 만나요
`# 제목`, `- 목록`, `[링크](https://...)`, ```코드블록``` 같은 문법으로 문서를 작성합니다.
- 이런 거 할 때 나와요 README, GitHub(깃허브) 이슈, 문서, 블로그 초안, AI 작업 지시문에서 매우 자주 쓰입니다.
- 이렇게 생겼어요 마크다운(Markdown)은(는) GitHub, README, Documentation 같은 주변 개념과 함께 문서, 설정 화면, 오류 메시지에서 자주 보입니다.
- 나오는 화면 예시 개발 기본 작업을 하다가 GitHub, README, Documentation를 확인하는 화면
헷갈리기 쉬운 점
서비스마다 지원하는 마크다운 문법이 조금씩 다를 수 있습니다. GitHub Flavored Markdown과 일반 Markdown의 차이를 확인해야 합니다.
왜 알아두면 좋을까요?
README, GitHub(깃허브) 이슈, 문서, 블로그 초안, AI 작업 지시문에서 매우 자주 쓰입니다.
Checklist
실제로 볼 때 확인할 것
- 01
제목 계층을 지킨다
- 02
코드블록에 언어명을 붙인다
- 03
링크와 이미지 경로가 실제로 열리는지 확인한다