궁극의 Markdown 치트 시트: 구문, 미리보기 및 모범 사례
Markdown은 일반 텍스트 형식의 구문을 사용하는 경량 마크업 언어입니다. README 파일, 문서 및 블로그 게시물에 널리 사용됩니다. 읽기 쉽고 쓰기 쉽기 때문에 Markdown은 개발자 커뮤니케이션의 표준이 되었습니다.
표준 Markdown 및 GitHub Flavored Markdown(GFM) 구문에 대한 빠른 참조로 이 치트 시트를 사용하세요.
1. 텍스트 서식
텍스트의 기본 스타일입니다.
| 요소 | 구문 | 결과 |
|---|---|---|
| 헤더 | # H1 ~ ###### H6 |
H1 ~ H6 |
| 굵게 | **text** 또는 __text__ |
text |
| 기울임꼴 | *text* 또는 _text_ |
text |
| 취소선 | ~~text~~ |
|
| 인용구 | > quote |
> quote |
| 가로선 | --- 또는 *** |
2. 목록
순서 있는 목록, 순서 없는 목록 또는 작업 목록으로 콘텐츠를 구성하세요.
- 순서 없는 목록:
*,-, 또는+를 사용합니다.- 항목 1 - 항목 2 - 하위 항목 - 순서 있는 목록: 숫자 뒤에 마침표를 사용합니다.
1. 첫 번째 항목 2. 두 번째 항목 - 작업 목록(GFM):
- [x] 완료된 작업 - [ ] 완료되지 않은 작업
3. 링크 및 이미지
- 링크:
[텍스트](URL)-> Google - 이미지:
 - 제목이 있는 링크:
[텍스트](URL "제목")
4. 코드 블록
- 인라인 코드: 작은따옴표 하나를 사용합니다:
`code`. - 코드 블록: 세 개의 작은따옴표와 선택적 언어 강조 표시를 사용합니다.
```javascript console.log("Hello, World!");
5. 표 및 고급 구문
표:
| 헤더 1 | 헤더 2 |
| :--- | :--- |
| 셀 1 | 셀 2 |
| 셀 3 | 셀 4 |
각주:
여기에 각주 참조[^1]가 있습니다.
[^1]: 이것은 각주 내용입니다.
6. Markdown의 종류(Flavors)
- CommonMark: 표준적이고 호환성이 높은 Markdown 버전입니다.
- GitHub Flavored Markdown(GFM): 표, 작업 목록, 취소선 및 자동 링크에 대한 지원을 추가합니다. 대부분의 최신 렌더러는 GFM을 지원합니다.
- Markdown 내 HTML: 더 복잡한 레이아웃을 위해 Markdown 내에서 원시 HTML 태그(
<u>또는<div>등)를 사용할 수 있습니다. 단, 일부 렌더러는 보안을 위해 이를 제거할 수 있습니다.
자주 묻는 질문(FAQ)
Q: Markdown을 어떻게 미리 볼 수 있나요?
A: VS Code와 같은 대부분의 코드 편집기에는 내장된 Markdown 미리보기(Ctrl+Shift+V) 기능이 있습니다. 온라인 Markdown 렌더러나 전용 편집기를 사용하여 문서가 HTML로 변환된 후 어떻게 보일지 확인할 수도 있습니다.
Q: Markdown 편집기와 렌더러의 차이점은 무엇인가요?
A: 편집기는 일반 텍스트 구문을 작성하는 곳입니다. 렌더러(또는 파서)는 해당 구문을 브라우저에 표시하기 위해 HTML로 변환하는 엔진입니다.
Q: Markdown 작성을 위한 모범 사례는 무엇인가요?
A:
- 일관성: 목록(
-vs*)과 헤더에 대해 하나의 스타일을 유지하세요. - 가독성: 단락과 목록 항목 사이에 빈 줄을 사용하세요.
- 대체 텍스트: 접근성을 위해 이미지에 항상 의미 있는 대체 텍스트를 제공하세요.
- 코드 펜싱: 구문 강조를 활성화하려면 코드 블록에 항상 언어를 지정하세요.
Tool3M 관련 도구
- Markdown to HTML: Markdown을 깨끗하고 프로ダクション 준비가 된 HTML로 즉시 변환하고 미리 봅니다.
- SQL Formatter: Markdown 문서에 붙여넣을 SQL 코드 블록의 서식을 지정합니다.