Manual Editor
사용자 설명서
제품 버전에 따라 메뉴 구성이 다르거나 일부 기능이 지원되지 않을 수 있습니다.
Manual Editor 시작하기
Manual Editor는 YAML 기반 매뉴얼 콘텐츠를 편집하고 Sanity CMS에 동기화하는 도구입니다.
Manual Editor 접근하기
Manual Editor에 접근하는 방법을 안내합니다.
- 브라우저에서 Manual Editor URL 열기개발 환경:
http://localhost:3010/admin/manual-editor프로덕션:https://your-domain.com/admin/manual-editor - 제품 선택상단 헤더의 제품 드롭다운에서 편집할 매뉴얼 제품을 선택합니다.
- 섹션 선택왼쪽 사이드바에서 편집할 섹션 파일을 클릭합니다.
편집 모드 (YAML / Form)
Manual Editor는 두 가지 편집 모드를 제공합니다.
- 전체 파일 구조를 한눈에 볼 수 있음
- 빠른 대량 수정에 유리
- YAML 문법에 익숙한 사용자에게 적합
_product.yaml파일은 YAML 모드에서만 편집 가능
- 직관적인 UI로 편집 가능
- 드래그 앤 드롭으로 순서 변경
- 이미지 선택기 내장
- 실시간 미리보기 제공
- 섹션 파일만 지원 (
_product.yaml제외)
자동 저장 기능
Manual Editor는 자동 저장 기능을 제공합니다.
- 2초 대기 후 자동 저장: 편집 후 2초간 입력이 없으면 자동으로 파일에 저장됩니다.
- 섹션 전환 시 즉시 저장: 다른 섹션으로 이동하면 현재 섹션의 변경사항이 즉시 저장됩니다.
- 저장 상태 표시: 사이드바의 노란 점(🟡)으로 배포되지 않은 섹션을 확인할 수 있습니다.
콘텐츠 편집하기
Form 모드에서 섹션, 서브섹션, 콘텐츠를 추가하고 편집하는 방법을 안내합니다.
새 섹션 추가하기
새로운 섹션 파일을 생성하는 방법을 안내합니다.
- + 버튼 클릭사이드바 상단의 "+" 버튼을 클릭합니다.
- 섹션 정보 입력모달 창에서 다음 정보를 입력합니다:
- 섹션 번호: 숫자만 입력 (예: "03")
- Slug: 영문 소문자, 숫자, 하이픈(-)만 사용 (예: "new-feature")
- 제목: 다국어 제목 입력
- 생성 완료✅ 버튼을 클릭하면 새 섹션 파일이 생성되고 자동으로 선택됩니다.
서브섹션 추가하기
섹션 내에 서브섹션을 추가하는 방법을 안내합니다.
- + 서브섹션 추가 버튼 클릭Form 모드에서 "+ 서브섹션 추가" 버튼을 클릭합니다.
- 서브섹션 정보 입력서브섹션의 다음 정보를 입력합니다:
- ID: 고유 식별자 (예: "feature-overview")
- 제목: 다국어 제목
- 설명: 다국어 설명 (선택)
콘텐츠 추가하기
서브섹션에 Step Guide, InfoBox, Screenshot, Table을 추가하는 방법을 안내합니다.
- 서브섹션 확장콘텐츠를 추가할 서브섹션을 클릭하여 확장합니다.
- 콘텐츠 타입 선택+콘텐츠 추가" 버튼을 클릭하고 원하는 콘텐츠 타입을 선택합니다.
- 콘텐츠 편집선택한 콘텐츠 타입에 맞는 필드를 입력합니다.
드래그 앤 드롭으로 순서 변경
서브섹션과 콘텐츠의 순서를 드래그 앤 드롭으로 변경할 수 있습니다.
- 항목 드래그이동하려는 서브섹션 또는 콘텐츠 항목을 클릭하고 드래그합니다.
- 목표 위치에 드롭원하는 위치로 드래그한 후 마우스를 놓으면 순서가 변경됩니다.
이미지 업로드 및 배포
이미지를 업로드하고 변경사항을 서버에 배포하는 방법을 안내합니다.
이미지 업로드하기
Manual Editor에 이미지를 업로드하는 방법을 안내합니다.
- 이미지 선택기 열기Form 모드에서 이미지 필드 옆의 "📷 이미지 선택" 버튼을 클릭합니다.
- 이미지 업로드이미지 선택기 모달에서: 1. "📤 업로드" 버튼 클릭 2. 업로드할 이미지 파일 선택 3. 업로드 완료 후 이미지 목록에서 선택
- 다국어 이미지 설정이미지 선택기에서 언어 탭(🇰🇷 한국어, 🇺🇸 English, 🇯🇵 日本語, 🇪🇸 Español)을 선택하여 각 언어별로 다른 이미지를 설정할 수 있습니다.
동기화 상태 확인
YAML 파일과 Sanity CMS 간의 동기화 상태를 확인하는 방법을 안내합니다.
- ✅ 동기화됨: YAML과 Sanity가 일치
- ⚠️ 차이점 있음: 일부 필드가 다름
- ❌ 배포 안됨: Sanity에 문서가 없음
- 🔄 확인 중: 상태 확인 중
- 노란 점 (🟡): 서버에 배포되지 않은 섹션
- 없음: 서버에 배포된 섹션
서버 배포하기
변경사항을 Sanity CMS에 동기화하고 서버에 배포하는 방법을 안내합니다.
- 변경사항 확인편집한 내용이 자동 저장되었는지 확인합니다. (2초 대기 또는 섹션 전환 시 자동 저장)
- 서버 배포 버튼 클릭헤더의 "🚀 서버 배포" 버튼을 클릭합니다.
- 전체 화면 로딩 오버레이가 표시됩니다
- Sanity CMS에 동기화가 진행됩니다
- 완료되면 토스트 메시지로 결과를 알려줍니다
- Git Commit (선택)"🚀 서버 배포" 버튼 옆의 "▼" 버튼을 클릭하여 "배포 + Commit"을 선택할 수 있습니다. Git Commit을 하려면: 1. Git 사용자 이름과 이메일 입력 2. 커밋 메시지 입력 3. "🚀 배포 + Commit" 버튼 클릭
- 서버 배포는 현재 열려있는 섹션에 대해서만 수행됩니다.
- Git Commit도 현재 섹션 파일과 해당 제품의 모든 이미지만 포함됩니다.
- 배포 전에 동기화 상태를 확인하여 차이점이 없는지 확인하는 것을 권장합니다.
팁 및 고급 기능
Manual Editor를 더 효율적으로 사용하기 위한 팁과 고급 기능을 안내합니다.
키보드 단축키
Manual Editor에서 사용할 수 있는 키보드 단축키를 안내합니다.
| 단축키 | 기능 | 설명 |
|---|---|---|
| Ctrl + S | 저장 | 현재 파일 저장 (자동 저장과 동일) |
| Ctrl + Z | 실행 취소 | YAML 모드에서만 사용 가능 |
| Ctrl + Y | 다시 실행 | YAML 모드에서만 사용 가능 |
| Ctrl + F | 찾기 | YAML 모드에서 텍스트 검색 |
Markdown 서식 사용하기
텍스트 필드에서 Markdown 문법을 사용하여 서식을 적용할 수 있습니다.
- 굵게:
**텍스트** - 기울임:
*텍스트* 코드: `코드`취소선:~~텍스트~~- 링크:
[텍스트](https://...) - 키보드:
{{kbd:Ctrl+S}} - 아이콘:
{{icon:house}}
콘텐츠 삭제하기
섹션, 서브섹션, 콘텐츠를 삭제하는 방법을 안내합니다.
- 섹션 삭제: 사이드바의 🗑️ 버튼
- 서브섹션 삭제: 서브섹션 헤더의 🗑️ 버튼
- 콘텐츠 삭제: 콘텐츠 항목의 🗑️ 버튼
- Step 삭제: Step Guide 내 Step의 🗑️ 버튼
모범 사례
Manual Editor를 효율적으로 사용하기 위한 모범 사례를 안내합니다.