마크다운(md) 작성 가이드

마크다운이란

마크다운(.md)은 일반 텍스트 파일입니다. 어떤 편집기로도 열 수 있고, # 이나 ** 같은 기호가 제목·굵게 같은 서식을 뜻합니다. 개발 문서(README), 블로그 초안, 회의록, 메모에 널리 쓰이고, 파일이 그냥 텍스트라서 버전 관리와 AI 도구에 넘기기 쉽습니다. DocLoom 의 md 편집기는 기호를 직접 보지 않고도 결과를 보며 쓸 수 있게 해 주지만, 저장되는 파일은 언제나 .md 원문입니다.

편집 보기 세 가지

• 문서형 — 결과를 보며 바로 씁니다. 상단 리본과 슬래시(/) 메뉴, 선택한 글자 위에 뜨는 서식 막대로 서식을 넣습니다. 표는 칸을 눌러 고칩니다.
• 소스 — 마크다운 원문을 구문 강조와 함께 직접 고칩니다. 찾기·바꾸기(Ctrl+H)와 줄로 이동(Ctrl+G)은 이 보기에서 씁니다.
• 분할 — 원문과 결과를 나란히 두고 씁니다.

보기는 Ctrl+E 나 보기 메뉴로 바꿉니다. 문서형에서 고쳐도 바꾸지 않은 부분의 원문 구문은 그대로 보존되고, 지원하지 않는 구문(HTML·각주·수식 등)도 원문 그대로 남습니다. 목차 패널로 제목 구조를 한눈에 보고 이동할 수 있습니다.

문법 요약

# 제목 (H1)
## 중제목 (H2)
### 소제목 (H3)

**굵게**  *기울임*  ~~취소선~~  `코드`

- 항목 1
- 항목 2
  - 하위 항목 (2칸 들여쓰기)

1. 첫째
2. 둘째
   1. 하위 항목

- [ ] 해야 할 일
- [x] 끝낸 일

| 이름 | 역할 |
| --- | :---: |
| 철수 | 개발 |
| 영희 | 기획 |

```js
console.log("hello");
```

[표시할 글자](https://example.com)
![그림 설명](https://example.com/a.png)

> 인용문입니다.
>
> > 중첩 인용

문단

---

다음 문단

---
title: 문서 제목
tags: [a, b]
---

\*별표\*  \# 해시  1\. 번호

잘 쓰는 요령

사람이 읽기에도, AI 나 다른 도구가 읽기에도 좋은 문서를 쓰는 습관입니다.

1. 제목 계층으로 구조를 보여 주세요

   AI 는 # 제목 단계를 문서의 뼈대로 읽습니다. H1 은 하나, 그 아래 H2, H3 로 순서대로 내려가고 단계를 건너뛰지 마세요(H1 다음에 H3 금지).

   # 보고서
   ## 배경
   ## 방법
   ### 데이터
   ## 결과

2. 비교·목록 데이터는 표로

   항목이 여러 개고 속성이 같으면 문장보다 표가 정확합니다. AI 가 읽기도, 사람이 확인하기도 쉽습니다.

   | 항목 | 값 |
   | --- | --- |
   | 기간 | 2주 |

3. 코드·명령·원문은 코드 펜스로

   코드, 명령어, JSON, 붙여 넣은 원문은 ``` 로 감싸고 언어를 적으세요. 어디서부터 어디까지가 "지시"이고 "데이터"인지 분명해집니다.

   ```json
   { "name": "예시" }
   ```

4. 프론트매터로 문서 정보를 분리

   제목·버전·태그·목적 같은 메타 정보는 문서 맨 위 --- 사이에 적습니다. 본문과 섞이지 않아 AI 와 도구가 따로 읽을 수 있습니다.

   ---
   title: 요약 지시문
   version: 2
   ---

5. 지시문은 역할 · 맥락 · 제약 · 출력 형식 순서로

   누구로서(역할), 어떤 상황(맥락), 무엇을 하지 말아야 하는지(제약), 어떤 모양으로 답할지(출력 형식)를 제목으로 나누어 쓰면 결과가 안정됩니다. "AI 프롬프트" 템플릿을 써 보세요.

6. 한 문단에는 한 가지 생각만

   긴 문단은 AI 도 사람도 놓칩니다. 3~4문장마다 나누고, 나열은 목록으로 바꾸세요.

7. 번호 목록은 순서가 있을 때만

   순서가 중요한 절차는 번호(1. 2. 3.), 순서가 없는 항목은 글머리(-)로 구분해 의도를 드러내세요.

8. 예시를 넣어 형식을 보여 주세요

   원하는 출력 형식은 설명보다 입력/출력 예시 한 쌍이 더 정확합니다.

9. 파일은 .md 그대로 주고받으세요

   이 편집기는 문서형으로 보며 고쳐도 저장은 .md 입니다. 바꾸지 않은 부분의 구문은 그대로 보존되고, 지원하지 않는 구문(HTML·각주·수식)도 원문 그대로 남습니다.

기본 제공 템플릿

새 마크다운 문서를 만들 때 빈 문서 또는 아래 한국어 템플릿에서 시작할 수 있습니다. 각 템플릿에는 "작성 안내" 인용구가 들어 있어 무엇을 채워야 하는지 알려 줍니다. 마음에 드는 것을 고르면 미리보기가 나오고, 시작하면 문서형 편집기로 열립니다.

템플릿 고르고 새 문서 만들기 · 사용 가이드로 돌아가기