Markdown 기초 가이드

Markdown 기초 가이드 (코딩용)

코딩하면서 꼭 필요한 Markdown 문법만 배워봅시다

🤔 왜 Markdown을 배워야 하나?

실제 사용 사례

1. README.md
   - 프로젝트 설명서
   - GitHub에서 자동으로 보여짐
   - 협업자들이 제일 먼저 보는 문서

2. 코드 문서화
   - 함수 설명
   - API 문서
   - 사용법 가이드

3. 메모/정리
   - 배운 내용 정리
   - 에러 해결 기록
   - 프로젝트 진행 상황

4. GitHub Issue / PR
   - 버그 리포트
   - 기능 제안
   - 코드 리뷰

Markdown의 장점

  • 간단함: HTML보다 훨씬 쉬움
  • 가독성: 텍스트 상태에서도 읽기 좋음
  • 범용성: GitHub, VS Code, Notion 등 어디서나 사용
  • 빠름: 마우스 없이 키보드만으로 작성

1️⃣ 제목 (Heading)

문법

# H1 제목 (프로젝트 이름)
## H2 제목 (큰 섹션)
### H3 제목 (작은 섹션)
#### H4 제목 (더 작은 섹션)

결과

H1 제목

H2 제목

H3 제목

H4 제목

실전 사용법

# 논문 정리 프로그램

## 설치 방법

### 필수 패키지

### 선택 패키지

## 사용 방법

### 기본 사용법

### 고급 기능

⚠️ 주의사항

  • # 뒤에 반드시 공백 필요: # 제목 ✅ / #제목 ❌
  • 한 문서에 H1은 하나만 (프로젝트 제목)
  • H2로 섹션 구분, H3로 세부 내용

✏️ 실습

본인 프로젝트의 README 제목 구조를 작성해보세요:

# [프로젝트 이름]

## 소개

## 설치 방법

## 사용 방법

## 라이선스

2️⃣ 코드 블록 (가장 중요!)

인라인 코드

문법:

변수 `x`에 값을 저장합니다.
`pip install pandas` 명령어를 실행하세요.

결과:

변수 x에 값을 저장합니다.
pip install pandas 명령어를 실행하세요.

코드 블록

문법:

```python
def hello():
    print("Hello, World!")
```

결과:

def hello():
    print("Hello, World!")

언어별 하이라이팅

```python
# Python 코드
import pandas as pd
```

```javascript
// JavaScript 코드
const x = 10;
```

```bash
# 터미널 명령어
pip install requests
```

```
# 일반 텍스트 (언어 지정 안 함)
그냥 텍스트
```

실전 사용법

## 설치 방법

다음 명령어를 실행하세요:

```bash
pip install -r requirements.txt
```

## 예제 코드

```python
import requests

response = requests.get("https://api.example.com")
print(response.json())
```

✏️ 실습

본인 코드 예시를 코드 블록으로 작성해보세요:

```python
# 여기에 본인 코드 작성
```

3️⃣ 리스트

순서 없는 리스트

문법:

- 항목 1
- 항목 2
- 항목 3

또는

* 항목 1
* 항목 2
* 항목 3

결과:

  • 항목 1
  • 항목 2
  • 항목 3

순서 있는 리스트

문법:

1. 첫 번째
2. 두 번째
3. 세 번째

결과:

  1. 첫 번째
  2. 두 번째
  3. 세 번째

중첩 리스트

문법:

- 대분류 1
  - 소분류 1-1
  - 소분류 1-2
- 대분류 2
  - 소분류 2-1

주의: 들여쓰기 2칸 또는 4칸

결과:

  • 대분류 1
    • 소분류 1-1
    • 소분류 1-2
  • 대분류 2
    • 소분류 2-1

실전 사용법

## 주요 기능

- 엑셀 처리
  - 파일 병합
  - 데이터 정렬
  - 그래프 생성
- 크롤링
  - 웹페이지 수집
  - 데이터 저장
- 자동화
  - 스케줄링
  - 이메일 알림

✏️ 실습

본인 프로젝트의 기능 목록을 작성해보세요:

## 기능 목록

- 
- 
-

4️⃣ 강조

굵게 (Bold)

문법:

**굵은 텍스트**
__굵은 텍스트__

결과: 굵은 텍스트

기울임 (Italic)

문법:

*기울임 텍스트*
_기울임 텍스트_

결과: 기울임 텍스트

굵게 + 기울임

문법:

***굵고 기울임***

결과: 굵고 기울임

취소선

문법:

~~취소선~~

결과: 취소선

실전 사용법

## 주의사항

**중요:** 이 파일을 삭제하면 안 됩니다!

*참고:* Python 3.8 이상 필요

~~이전 버전 지원 종료~~

✏️ 실습

중요한 단어를 강조해보세요:

이 프로젝트는 **Python**을 사용하며, *pandas* 라이브러리가 필요합니다.

5️⃣ 구분선

문법

---

또는

***

또는

___

결과

실전 사용법

# 프로젝트 제목

프로젝트 간단 설명

---

## 설치 방법

...

---

## 사용 방법

...

6️⃣ 인용/주의사항

문법

> 이것은 인용문입니다.
> 여러 줄도 가능합니다.

결과:

이것은 인용문입니다.
여러 줄도 가능합니다.

중첩 인용

> 첫 번째 레벨
>> 두 번째 레벨
>>> 세 번째 레벨

결과:

첫 번째 레벨

두 번째 레벨

세 번째 레벨

실전 사용법

> **주의:** 이 스크립트는 파일을 영구 삭제합니다.

> **팁:** Ctrl+C로 언제든 중단할 수 있습니다.

7️⃣ 테이블 (선택)

기본 문법

| 항목 | 설명 | 비고 |
|------|------|------|
| Python | 프로그래밍 언어 | 필수 |
| pandas | 데이터 처리 | 선택 |

결과:

항목 설명 비고
Python 프로그래밍 언어 필수
pandas 데이터 처리 선택

정렬

| 왼쪽 정렬 | 가운데 정렬 | 오른쪽 정렬 |
|:----------|:----------:|----------:|
| 텍스트 | 텍스트 | 텍스트 |

결과:

왼쪽 정렬 가운데 정렬 오른쪽 정렬
텍스트 텍스트 텍스트

실전 사용법

## 의존성

| 패키지 | 버전 | 필수 여부 |
|--------|------|-----------|
| Python | 3.8+ | 필수 |
| pandas | 1.3+ | 필수 |
| requests | 2.0+ | 선택 |

8️⃣ 체크리스트

문법

- [ ] 할 일 1
- [x] 완료된 할 일
- [ ] 할 일 2

결과:

  • 할 일 1
  • 완료된 할 일
  • 할 일 2

실전 사용법

## 프로젝트 진행 상황

- [x] 환경 설정
- [x] 기본 기능 구현
- [ ] 테스트 작성
- [ ] 문서 작성
- [ ] 배포

9️⃣ 실전 예시: 완전한 README.md

# 논문 PDF 정리 프로그램

PDF 파일에서 제목과 저자를 자동으로 추출하여 엑셀로 정리하는 프로그램입니다.

---

## 주요 기능

- PDF 파일 자동 읽기
- 제목 및 저자 추출
- 엑셀 파일로 저장
- 파일명 자동 정리

---

## 설치 방법

### 1. Python 설치

Python 3.8 이상이 필요합니다.

### 2. 패키지 설치

```bash
pip install -r requirements.txt

필수 패키지:

  • PyPDF2
  • pandas
  • openpyxl

사용 방법

기본 사용법

python main.py --input papers/ --output result.xlsx

옵션

옵션 설명 기본값
–input 입력 폴더 papers/
–output 출력 파일 result.xlsx

예제

from paper_parser import PaperParser

parser = PaperParser()
parser.process_folder("papers/")
parser.save_to_excel("result.xlsx")

주의사항

경고: 대용량 PDF 처리시 시간이 오래 걸릴 수 있습니다.

팁: --verbose 옵션으로 진행 상황을 확인할 수 있습니다.

라이선스

MIT License


---

## 🎯 핵심 정리

### 가장 많이 쓰는 문법 (외워두세요!)

```markdown
# 제목

## 섹션

**굵게**

`인라인 코드`

```python
코드 블록
  • 리스트

인용


### 학습 순서

1단계: 제목 + 코드 블록 (필수) 2단계: 리스트 + 강조 3단계: 구분선 + 인용 4단계: 테이블 + 체크리스트 (선택)


---

## 📚 추가 학습 자료

### 인터랙티브 튜토리얼

- https://www.markdowntutorial.com/kr
  - Gamification된 학습 사이트
  - 단계별 실습
  - 즉시 피드백

### 연습 도구

- **VS Code**: 실시간 미리보기 (Ctrl+Shift+V)
- **GitHub**: README 작성하면서 바로 확인
- **Typora**: WYSIWYG 마크다운 에디터

---

## ✏️ 최종 실습

본인 프로젝트의 README.md를 작성해보세요!

```markdown
# [프로젝트 이름]

[한 줄 설명]

---

## 주요 기능

- 
- 
- 

---

## 설치 방법

```bash
pip install ...

사용 방법

# 예제 코드

라이선스

MIT


**제출 위치:** 본인 프로젝트 폴더의 `README.md`

---

## 🎓 마무리

### Markdown을 배우면

✅ README.md 작성 가능 ✅ 프로젝트 문서화 가능 ✅ GitHub Issue/PR 작성 편해짐 ✅ 메모/정리 효율 UP ```

기억하세요

“처음부터 완벽하게 쓸 필요 없습니다.
필요한 문법부터 하나씩 익혀가세요!”

작성일: 2025년 2월 9일
버전: 1.0
대상: 바이브 코딩 수강생