마크다운 에디터 완벽 가이드: 온라인에서 마크다운 작성과 미리보기
마크다운은 기술 문서 작성의 공용어가 되었습니다. 2004년 존 그루버(John Gruber)가 만든 마크다운은 일반 텍스트를 포맷된 HTML로 변환하는 경량 마크업 언어입니다. GitHub의 README 파일과 이슈, Notion과 Obsidian의 노트 작성, Jekyll과 Hugo의 정적 사이트 생성, Stack Overflow의 질문과 답변에 사용되며, 전 세계 수백만 개발자가 문서화에 사용합니다. 이 가이드는 기본 구문부터 고급 포맷팅 기법까지 마크다운에 대해 알아야 할 모든 것을 다룹니다.
마크다운이란 무엇이며 왜 사용해야 하나요?
마크다운은 원시 형태에서도 사람이 읽을 수 있고 HTML로 쉽게 변환할 수 있도록 설계된 일반 텍스트 포맷팅 구문입니다. 포맷팅이 도구 모음 버튼 뒤에 숨겨진 위지윅(WYSIWYG) 편집기와 달리, 마크다운은 누구나 몇 분 만에 배울 수 있는 직관적인 텍스트 규칙을 사용합니다.
마크다운의 핵심 장점: 이식성(모든 OS, 편집기, 플랫폼에서 작동하는 일반 텍스트), 버전 관리 친화성(Git과 완벽 호환), 간결성(최소한의 직관적 구문), 미래 보장(일반 텍스트 파일은 절대 구식이 되지 않음).
필수 마크다운 구문
제목
해시 기호로 제목을 만듭니다. 해시 수가 제목 수준에 해당합니다:
# 제목 1
## 제목 2
### 제목 3
텍스트 서식
**굵은 텍스트**
*기울임 텍스트*
***굵은 기울임***
~~취소선~~
`인라인 코드`
링크와 이미지
[링크 텍스트](https://example.com)
목록
- 항목 하나
- 항목 둘
- 중첩 항목
1. 첫 번째 항목
2. 두 번째 항목
코드 블록
인라인: `const x = 42;`를 코드에 사용하세요.
언어 지정이 있는 펜스 블록:
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
```
테이블
| 기능 | 마크다운 | HTML |
|----------|----------|-------|
| 학습 | 쉬움 | 보통 |
| 가독성 | 높음 | 낮음 |
인용문
> 이것은 인용문입니다.
> 여러 줄에 걸칠 수 있습니다.
GitHub 확장 마크다운 (GFM)
GitHub은 표준 마크다운을 여러 기능으로 확장했습니다:
작업 목록: - [x] 완료된 작업, - [ ] 미완료 작업 형식의 인터랙티브 체크리스트.
자동 링크 참조: #123, @username, 커밋 SHA를 입력하면 자동으로 링크가 생성됩니다.
이모지 단축 코드: :+1:, :rocket:, :bug: 등의 텍스트 코드로 이모지를 추가할 수 있습니다.
각주: 본문을 어지럽히지 않으면서 참조를 추가할 수 있습니다.
문서화를 위한 마크다운 모범 사례
문서를 논리적으로 구조화하세요
명확한 제목(H1)으로 시작하고, 간략한 소개를 따르며, 필요에 따라 하위 섹션(H3)이 있는 체계적인 섹션(H2)으로 구성하세요. 긴 문서에는 목차를 포함하세요.
설명적인 링크 텍스트를 작성하세요
"여기를 클릭하세요"와 같은 일반적인 링크 텍스트를 피하세요. 대신 [API 인증 문서](링크)처럼 독자가 무엇을 찾을지 설명하는 링크 텍스트를 만드세요.
코드 블록을 충분히 사용하세요
기술 문서를 작성할 때 파일 이름, 명령어, 함수 이름, 변수 이름에는 인라인 코드를 사용하세요. 여러 줄의 코드 예제, 설정 파일, 터미널 명령어에는 펜스 코드 블록을 사용하세요.
시각적 요소를 포함하세요
텍스트 벽을 이미지, 다이어그램, 테이블, 코드 예제로 분할하세요. 시각적 요소는 이해력을 향상시키고 문서를 더 쉽게 스캔할 수 있게 만듭니다.
마크다운 vs. 다른 마크업 언어
마크다운 vs. HTML: 마크다운은 원시 형태에서 훨씬 간단하고 읽기 쉽습니다. 콘텐츠 작성에는 마크다운을 사용하고 도구가 HTML로 변환하게 하세요.
마크다운 vs. reStructuredText: reStructuredText는 더 강력하지만 학습 곡선이 더 가파릅니다. 대부분의 문서화 요구에는 마크다운이 충분합니다.
마크다운 vs. AsciiDoc: AsciiDoc은 더 복잡한 문서 구조를 지원하며 대규모 기술 문서에 선호됩니다. 마크다운은 간결성과 생태계 지원에서 승리합니다.
흔한 마크다운 실수
빈 줄 누락: 마크다운은 제목, 코드 블록, 목록, 인용문 전후에 빈 줄이 필요합니다. 이를 잊으면 렌더링 문제가 발생합니다.
특수 문자 미이스케이프: *, _, #, [ 등의 문자는 마크다운에서 특별한 의미가 있습니다. 문자 그대로 표시하려면 백슬래시로 이스케이프하세요.
과도한 중첩: 3레벨 이상의 중첩은 읽기 어렵습니다. 콘텐츠를 재구성하는 것을 고려하세요.
UtiliZest로 마크다운을 즉시 작성하고 미리보기하세요
UtiliZest의 마크다운 에디터는 왼쪽에서 마크다운을 작성하고 오른쪽에서 렌더링된 HTML 출력을 실시간으로 볼 수 있는 병렬 라이브 미리보기 경험을 제공합니다. 테이블, 작업 목록, 구문 강조가 포함된 코드 블록 등 GitHub 확장 마크다운을 완전히 지원합니다.
서버로 데이터가 전송되지 않으며 브라우저에서 모든 것이 실행됩니다. 가입 없이 완전히 무료입니다.