전형적인 README 도입부
# Project Name
A short description in one or two sentences.
## Install
```bashnpm install project-name```
## Quick start
- Step 1- Step 2- Step 3제목, 짧은 설명, 설치 명령어를 담은 코드 펜스, 그리고 글머리 기호 목록. 잘 쓰인 README는 대부분 이 뼈대를 따릅니다.
실시간 분할 미리보기로 Markdown 작성.
마지막 업데이트
Markdown 에디터는 좌우로 나뉜 작성 환경입니다. 한쪽에 일반 텍스트로 Markdown을 입력하면, 다른 쪽에 렌더링된 미리보기가 실시간으로 갱신됩니다. GitHub의 README, 각종 문서 사이트, 정적 사이트 생성기, 블로그 플랫폼, Obsidian 같은 노트 앱, 그리고 Discord나 Slack 같은 메신저까지 — Markdown은 이런 곳들의 텍스트 포맷을 책임지고 있습니다.
Markdown의 핵심은 "평문 상태에서도 읽기 쉽고, 렌더링하면 구조화된 HTML이 된다"는 점입니다. 서식 툴바를 만지작거릴 시간에 글 자체에 집중할 수 있죠. 기술 문서를 쓰는 사람과 개발자들이 Markdown을 선호하는 이유가 여기에 있습니다.
요즘 대부분의 Markdown 에디터는 *GitHub-Flavored Markdown*(GFM)을 지원합니다. 기본 CommonMark 스펙에 표, 체크리스트, 언어 힌트가 붙는 코드 펜스, 자동 링크, 취소선 같은 것들이 더해진 방언입니다.
js , python )를 붙이면 많은 렌더러에서 구문 강조가 자동으로 적용됩니다.제목은 #, 강조는 *나 _, 목록은 -로 시작합니다. 입력하는 즉시 오른쪽 창이 갱신됩니다.
제목, 코드 펜스, 표를 적절히 넣어 문서 흐름을 정리하세요. 대부분의 에디터는 자주 쓰는 서식에 단축키(Ctrl+B, Ctrl+I)를 지원합니다.
미리보기와 원본 소스를 나란히 비교해 보세요. 결과가 이상하게 나온다면 십중팔구 빈 줄이 빠졌거나 코드 펜스가 짝이 맞지 않은 경우입니다.
Markdown 원본을 그대로 복사해 README에 붙여 넣거나, 렌더링된 HTML을 복사해 Markdown을 지원하지 않는 이메일·CMS·기타 도구에 붙여 넣으면 됩니다.
매일 쓰게 되는 Markdown의 80%만 정리했습니다. 그 외에는 검색 한 번이면 충분해요. 스펙은 CommonMark와 GitHub-Flavored Markdown을 참고하세요.
| 요소 | Markdown | 렌더링 결과 |
|---|---|---|
| 제목 1단계 | # Title | 최상위 제목 |
| 제목 2단계 | ## Section | 섹션 제목 |
| 굵게 | **strong** | **strong** |
| 기울임 | *emphasis* 또는 _emphasis_ | *emphasis* |
| 인라인 코드 | code | code |
| 코드 블록 | 백틱 세 개로 펜스를 만들고, 필요하면 언어 힌트를 붙입니다 | 구문 강조가 적용된 블록 |
| 링크 | `label` | 클릭 가능한 링크 |
| 이미지 | `!alt` | 본문에 삽입된 이미지 |
| 목록 | - item | 글머리 기호 목록 |
| 번호 목록 | 1. item | 순서 있는 목록 |
| 체크리스트 (GFM) | - [x] done | 체크된 체크박스 |
| 표 (GFM) | | a | b |\n|---|---|\n| 1 | 2 | | 두 열짜리 표 |
| 인용문 | > quote | 들여쓴 인용문 |
# Project Name
A short description in one or two sentences.
## Install
```bashnpm install project-name```
## Quick start
- Step 1- Step 2- Step 3제목, 짧은 설명, 설치 명령어를 담은 코드 펜스, 그리고 글머리 기호 목록. 잘 쓰인 README는 대부분 이 뼈대를 따릅니다.
| Feature | Free | Pro ||---------|:----:|:---:|| Editor | ✓ | ✓ || Export | | ✓ |파이프(|)로 열을 나눕니다. 두 번째 줄의 대시 라인이 열을 정렬해주고, : 위치로 좌·중·우 정렬을 지정할 수 있어요. GFM 표는 열 너비를 정확히 맞출 필요가 없습니다 — 구조만 맞으면 됩니다.
- [x] Draft the post- [x] Add screenshots- [ ] PublishGitHub의 이슈와 PR에서는 이게 실제로 클릭되는 체크박스로 렌더링됩니다. 문서 안에 체크리스트를 넣거나 가벼운 작업 관리를 할 때 유용합니다.
# heading, **bold**, `link` 같은 단순한 평문 문법을 HTML로 변환해 줍니다. 원본 상태에서도 충분히 읽힐 수 있도록 설계된 게 특징이에요.marked, markdown-it, pandoc 같은 변환 도구를 직접 돌려도 됩니다. 정적 사이트 생성기 대부분은 빌드 시점에 자동으로 처리해 줍니다.