마크다운 코드 블록

코드 블록은 기술 문서, 튜토리얼, 그리고 코드 예제를 포함한 모든 콘텐츠에 필수적입니다. 마크다운은 간단한 인라인 코드부터 문법 강조가 있는 전체 코드 블록까지 코드를 서식화하는 여러 가지 방법을 제공합니다.

인라인 코드

문장 내의 짧은 코드 조각에는 단일 백틱을 사용합니다:

`git status` 명령을 사용하여 저장소를 확인하세요.
`console.log()` 함수는 콘솔에 출력합니다.
프로세스를 중지하려면 `Ctrl+C`를 누르세요.

결과:

git status 명령을 사용하여 저장소를 확인하세요. console.log() 함수는 콘솔에 출력합니다. 프로세스를 중지하려면 Ctrl+C를 누르세요.

펜스 코드 블록

여러 줄 코드에는 삼중 백틱을 사용합니다:

```
function greet(name) {
  console.log("안녕하세요, " + name + "!");
}

greet("세상");
```

결과:

function greet(name) {
  console.log("안녕하세요, " + name + "!");
}

greet("세상");

문법 강조

문법 강조를 위해 여는 백틱 뒤에 언어 이름을 추가합니다:

JavaScript

```javascript
function calculateSum(a, b) {
  return a + b;
}

const result = calculateSum(5, 3);
console.log(result); // 출력: 8
```

Python

```python
def calculate_sum(a, b):
    return a + b

result = calculate_sum(5, 3)
print(result)  # 출력: 8
```

언어	식별자	대안
JavaScript	`javascript`	`js`
Python	`python`	`py`
Java	`java`
C++	`cpp`	`c++`
C#	`csharp`	`cs`
HTML	`html`
CSS	`css`
SQL	`sql`
JSON	`json`
XML	`xml`
Shell	`bash`	`sh`
TypeScript	`typescript`	`ts`
React JSX	`jsx`
PHP	`php`
Go	`go`
Rust	`rust`
Swift	`swift`

중요한 참고사항

펜스 코드 블록은 더 나은 문법 강조를 제공하고 다양한 플랫폼에서 더 광범위하게 지원되므로 마크다운에서 코드를 서식화하는 데 선호되는 방법입니다.

모범 사례

1. 항상 문법 강조 사용

❌ 문법 강조 없음:

```
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

✅ 문법 강조 있음:

```javascript
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

2. 코드 예제를 집중적으로 유지

❌ 관련 없는 코드가 너무 많음:

```javascript
// 많은 설정 코드...
const express = require('express');
const app = express();
const PORT = 3000;

// ... 더 많은 설정 ...

// 실제 예제 (설정에 묻혀 있음)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... 더 많은 보일러플레이트 ...
```

✅ 중요한 부분에 집중:

```javascript
// 간단한 API 엔드포인트 생성
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

일반적인 사용 사례

API 문서

요청:

POST /api/users
Content-Type: application/json

{
  "name": "홍길동",
  "email": "[email protected]"
}

응답:

{
  "id": 123,
  "name": "홍길동",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

구성 파일

프로젝트 루트에 .env 파일을 생성하세요:

# 데이터베이스 구성
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=password123

# API 키
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here

문제 해결

일반적인 문제

코드가 서식화되지 않음: 올바른 백틱 확인

문법 강조가 작동하지 않음: 언어 식별자 확인
코드가 레이아웃을 깨뜨림: 적절한 줄 바꿈 사용

백틱 이스케이프

코드에서 백틱을 보여줘야 하는 경우:

단일 백틱 예제:

•
작성: `코드`
•
결과: 코드

삼중 백틱 예제:

•
작성: ```코드 블록```
•
결과: 코드 블록

인라인 코드의 백틱:

•
작성: ``백틱``
•
결과: 백틱

코드 블록은 기술 문서에 필수적입니다. 이를 사용하여 코드 예제를 명확하고 읽기 쉽게, 그리고 올바르게 서식화하세요!

마지막으로, 텍스트 서식을 완벽하게 하기 위해 줄 바꿈에 대해 배워보세요.