코드 포맷은 Markdown의 가장 강력한 기능 중 하나입니다. 함수를 문서화하거나, 터미널 명령어를 표시하거나, 튜토리얼을 작성하더라도, 마크다운 코드 문법은 코드를 시각적으로 구별합니다. 적절하게 포맷하고 (대부분의 플랫폼에서) 문법으로 강조되어 있습니다. 이 안내서 는 Markdown 코드 블록.
인라인 코드
단편적인 단편 또는 단편적인 표현을 단편적인 백티크로 포장:
Use `console.log()` to print output.
Set the variable with `const x = 42;`.
The file is saved as `README.md`.인라인 코드는 모노스페이스 글꼴로 렌더링되며, 주변 텍스트와 시각적으로 구별된다. 사용:
- 함수 및 방법 이름:
addEventListener() - 변수 명칭:
isLoading - 파일 이름:
package.json - 명령어 문장:
--verbose - 짧은 코드 표현식
인라인 코드가 백틱을 포함한다면, 이중 백틱을 사용하여 포착하십시오.
`` `backtick inside` ``울타리 된 코드 블록
복선 코드에 대해, 블록을 열고 닫기 위해 세 배 백틱 (`) 을 사용한다.
```
This is a code block.
It preserves all whitespace and line breaks.
No formatting is applied inside.
```틈새, 간격, 그리고 새선들은 모두 정확히 보존되어 있습니다.
문법 강조
문법 하이라이트를 활성화하기 위해 개막 트리플 백틱 뒤에 언어 식별자를 추가합니다.
```python
def greet(name: str) -> str:
return f"Hello, {name}!"
print(greet("World"))
``````javascript
const greet = (name) => `Hello, ${name}!`;
console.log(greet("World"));
``````bash
#!/bin/bash
echo "Hello, World!"
ls -la ~/Documents
```공통 언어 식별자
| 언어 | 식별자 |
|---|---|
| 파이썬 | python |
| JavaScript | javascript or js |
| 타입스크립트 | typescript or ts |
| HTML | html |
| CSS | css |
| JSON | json |
| YAML | yaml or yml |
| 바쉬/ | bash or sh |
| SQL | sql |
| Markdown | markdown or md |
| 자바 | java |
| C | c |
| C++ | cpp |
| C# | csharp |
| 가요 | go |
| 산화 | rust |
| 루비 | ruby |
| PHP | php |
| 스위프트 | swift |
| 코틀린 | kotlin |
| R | r |
| 파워 셸 | powershell |
| 도커파일 | dockerfile |
| XML | xml |
| TOML | toml |
| HTTP | http |
| 디프 | diff |
인더테이트 코드 블록
오래된 Markdown 문법은 코드 블록을 위해 4개의 공간 인덴테이션을 사용합니다.
function oldStyle() {
return "This is a code block";
}이것은 CommonMark에 호환되지만 덜 읽을 수 있으며 언어 식별자를 지원하지 않습니다. 그 대신 울타리 로 된 블록 (삼 배 의 뒷줄) 을 사용 하십시오.
Word 문서에서 코드를 변환
Word (Courier New, Consolas, 등) 에서의 단공간 텍스트는 사용시 인라인 코드로 변환됩니다. WordToMD. Multi-line code in Word converts depending on how it was formatted:
- 모노스페이스 글꼴 단락 → 복수의 인라인 코드 조각이 될 수 있습니다
- Word 코드 스타일 → 코드 블록으로 변환
- 문자적 텍스트 블록 → 수동 장벽 설치가 필요할 수 있습니다
변환 후, 코드 섹션을 확인하고 필요한 경우 적절한 울타리를 추가:
- 블록이 되어야 하는 코드를 찾으세요
- 세 배의 랩틱으로 싸고
- 적절한 언어 식별자를 추가
언어 특유의 예제
HTTP 요청
```http
POST /api/users HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer TOKEN
{
"name": "Alice",
"email": "alice@example.com"
}
```터미널 명령어
```bash
npm install
npm run build
npm run dev
```디프 출력
```diff
- const oldValue = "hello";
+ const newValue = "world";
console.log(newValue);
```YAML 구성
```yaml
server:
host: localhost
port: 8080
debug: true
database:
url: postgresql://localhost:5432/mydb
```넥스트 코드 블록 (문서를 위한)
Markdown 자체를 문서화할 때, 4개의 백틱을 사용하여 3개의 백틱을 포함하는 블록을 포장합니다.
````markdown
```python
# This is a code block inside documentation
```
````플랫폼 지원
| 플랫폼 | 인라인 코드 | 울타리 로 된 블록 | 문법 강조 |
|---|---|---|---|
| GitHub | ✅ | ✅ | ✅ |
| GitLab | ✅ | ✅ | ✅ |
| Obsidian | ✅ | ✅ | ✅ |
| GitBook | ✅ | ✅ | ✅ |
| Notion | ✅ | ✅ | ✅ |
| Confluence (Markdown) | ✅ | ✅ | ✅ |
| VS 코드 | ✅ | ✅ | ✅ |
라인 번호
표준 Markdown은 코드 블록의 줄 번호를 지원하지 않습니다. 일부 플랫폼과 정적 사이트 생성자는 플러그인을 통해 이것을 추가합니다:
- Prism.js (많은 SSG에서 사용) 추가
{numberLines: true}코드 울타리 안에 - GitHub 렌더링 Markdown에서 네이티브 라인 번호가 없습니다 (그 대신 GitHub Blame 뷰를 사용)
- GitBook 코드 블록 설정을 통해 줄 번호
블록에서 코드를 복사
GitHub와 많은 플랫폼은 자동으로 코드 블록에 Copy 버튼을 추가합니다. 이것은 렌더링 향상입니다. Markdown에 특별한 것이 필요하지 않습니다.
FAQ
왜 제 코드 블록 문법이 강조되지 않는가? 언어 식별자는 없거나 잘못 작성되었거나 플랫폼은 특정 언어를 지원하지 않습니다. 위의 식별자 목록을 확인하세요.
어떻게 코드 블록 안에 있는 배크틱을 표시할 수 있을까요? 울타리된 코드 블록 안에서, 백틱은 문자 그대로의 문자로 취급됩니다. 세 개의 뒷줄이 있는 울타리만 특별하게 처리해야 합니다.
제 Word 문서에는 다채로운 문법 강조 코드가 있었습니다. WordToMD가 색을 보존할 수 있을까요? Markdown 코드 블록은 컬러 포맷을 보존하지 않습니다. WordToMD는 텍스트를 코드 블록으로 변환합니다. 문법 하이라이트는 언어 식별자에 기반한 Markdown 렌더러에 의해 적용됩니다.
코드 블록 안에 특정 라인을 강조할 수 있나요?
표준 Markdown은 이것을 지원하지 않습니다. 일부 플랫폼 (이스트로와 시키, 또는 휴고와 같은) 은 댓글을 통해 강조하는 지원 라인을 제공합니다: {1,3-5} 언어 식별자 뒤에 있습니다.
관련 가이드
- Markdown 문법 빠른 참조표 전체 참조
- Word ~ API 문서 코드가 많은 문서
- Word to GitHub Markdown GitHub-특정 코드 형식
결론
마크다운 코드 블록은 간단합니다: 인라인 코드용 백틱, 블록에 대한 언어 식별자와 함께 트리플 백틱. Word 문서를 Word로 변환한 후 WordToMD, 단일 공간 텍스트가 코드 문법으로 올바르게 포장되었는지 확인합니다. 그리고 타겟 플랫폼에서 적절한 문법 강조를 위해 언어 식별자를 추가합니다.