Manual Editor

사용자 설명서

Ver. 1.0

제품 버전에 따라 메뉴 구성이 다르거나 일부 기능이 지원되지 않을 수 있습니다.

01

Manual Editor 시작하기

Manual Editor는 YAML 기반 매뉴얼 콘텐츠를 편집하고 Sanity CMS에 동기화하는 도구입니다.

Manual Editor 접근하기

Manual Editor에 접근하는 방법을 안내합니다.

  1. 브라우저에서 Manual Editor URL 열기
    개발 환경: http://localhost:3010/admin/manual-editor 프로덕션: https://your-domain.com/admin/manual-editor
  2. 제품 선택
    상단 헤더의 제품 드롭다운에서 편집할 매뉴얼 제품을 선택합니다.
  3. 섹션 선택
    왼쪽 사이드바에서 편집할 섹션 파일을 클릭합니다.

편집 모드 (YAML / Form)

Manual Editor는 두 가지 편집 모드를 제공합니다.

YAML 모드
YAML 모드는 원본 YAML 파일을 직접 편집합니다.
  • 전체 파일 구조를 한눈에 볼 수 있음
  • 빠른 대량 수정에 유리
  • YAML 문법에 익숙한 사용자에게 적합
  • _product.yaml 파일은 YAML 모드에서만 편집 가능
Form 모드
Form 모드는 시각적인 폼 인터페이스로 편집합니다.
  • 직관적인 UI로 편집 가능
  • 드래그 앤 드롭으로 순서 변경
  • 이미지 선택기 내장
  • 실시간 미리보기 제공
  • 섹션 파일만 지원 (_product.yaml 제외)

자동 저장 기능

Manual Editor는 자동 저장 기능을 제공합니다.

자동 저장 동작
  • 2초 대기 후 자동 저장: 편집 후 2초간 입력이 없으면 자동으로 파일에 저장됩니다.
  • 섹션 전환 시 즉시 저장: 다른 섹션으로 이동하면 현재 섹션의 변경사항이 즉시 저장됩니다.
  • 저장 상태 표시: 사이드바의 노란 점(🟡)으로 배포되지 않은 섹션을 확인할 수 있습니다.
02

콘텐츠 편집하기

Form 모드에서 섹션, 서브섹션, 콘텐츠를 추가하고 편집하는 방법을 안내합니다.

새 섹션 추가하기

새로운 섹션 파일을 생성하는 방법을 안내합니다.

  1. + 버튼 클릭
    사이드바 상단의 "+" 버튼을 클릭합니다.
  2. 섹션 정보 입력
    모달 창에서 다음 정보를 입력합니다:
    • 섹션 번호: 숫자만 입력 (예: "03")
    • Slug: 영문 소문자, 숫자, 하이픈(-)만 사용 (예: "new-feature")
    • 제목: 다국어 제목 입력
  3. 생성 완료
    ✅ 버튼을 클릭하면 새 섹션 파일이 생성되고 자동으로 선택됩니다.

서브섹션 추가하기

섹션 내에 서브섹션을 추가하는 방법을 안내합니다.

  1. + 서브섹션 추가 버튼 클릭
    Form 모드에서 "+ 서브섹션 추가" 버튼을 클릭합니다.
  2. 서브섹션 정보 입력
    서브섹션의 다음 정보를 입력합니다:
    • ID: 고유 식별자 (예: "feature-overview")
    • 제목: 다국어 제목
    • 설명: 다국어 설명 (선택)

콘텐츠 추가하기

서브섹션에 Step Guide, InfoBox, Screenshot, Table을 추가하는 방법을 안내합니다.

콘텐츠 타입
Manual Editor는 다음 4가지 콘텐츠 타입을 지원합니다: 1. Step Guide: 단계별 가이드 (이미지 포함 가능) 2. InfoBox: 정보 박스 (info, warning, tip, danger) 3. Screenshot: 스크린샷 이미지 4. Table: 표 (manualTable)
  1. 서브섹션 확장
    콘텐츠를 추가할 서브섹션을 클릭하여 확장합니다.
  2. 콘텐츠 타입 선택
    +콘텐츠 추가" 버튼을 클릭하고 원하는 콘텐츠 타입을 선택합니다.
  3. 콘텐츠 편집
    선택한 콘텐츠 타입에 맞는 필드를 입력합니다.

드래그 앤 드롭으로 순서 변경

서브섹션과 콘텐츠의 순서를 드래그 앤 드롭으로 변경할 수 있습니다.

  1. 항목 드래그
    이동하려는 서브섹션 또는 콘텐츠 항목을 클릭하고 드래그합니다.
  2. 목표 위치에 드롭
    원하는 위치로 드래그한 후 마우스를 놓으면 순서가 변경됩니다.
03

이미지 업로드 및 배포

이미지를 업로드하고 변경사항을 서버에 배포하는 방법을 안내합니다.

이미지 업로드하기

Manual Editor에 이미지를 업로드하는 방법을 안내합니다.

  1. 이미지 선택기 열기
    Form 모드에서 이미지 필드 옆의 "📷 이미지 선택" 버튼을 클릭합니다.
  2. 이미지 업로드
    이미지 선택기 모달에서: 1. "📤 업로드" 버튼 클릭 2. 업로드할 이미지 파일 선택 3. 업로드 완료 후 이미지 목록에서 선택
  3. 다국어 이미지 설정
    이미지 선택기에서 언어 탭(🇰🇷 한국어, 🇺🇸 English, 🇯🇵 日本語, 🇪🇸 Español)을 선택하여 각 언어별로 다른 이미지를 설정할 수 있습니다.

동기화 상태 확인

YAML 파일과 Sanity CMS 간의 동기화 상태를 확인하는 방법을 안내합니다.

동기화 상태 아이콘
헤더의 동기화 상태 아이콘으로 현재 상태를 확인할 수 있습니다:
  • 동기화됨: YAML과 Sanity가 일치
  • ⚠️ 차이점 있음: 일부 필드가 다름
  • 배포 안됨: Sanity에 문서가 없음
  • 🔄 확인 중: 상태 확인 중
사이드바 표시
사이드바의 섹션 목록에서:
  • 노란 점 (🟡): 서버에 배포되지 않은 섹션
  • 없음: 서버에 배포된 섹션
노란 점이 있는 섹션은 "서버 배포" 버튼을 클릭하여 배포해야 합니다.

서버 배포하기

변경사항을 Sanity CMS에 동기화하고 서버에 배포하는 방법을 안내합니다.

  1. 변경사항 확인
    편집한 내용이 자동 저장되었는지 확인합니다. (2초 대기 또는 섹션 전환 시 자동 저장)
  2. 서버 배포 버튼 클릭
    헤더의 "🚀 서버 배포" 버튼을 클릭합니다.
    • 전체 화면 로딩 오버레이가 표시됩니다
    • Sanity CMS에 동기화가 진행됩니다
    • 완료되면 토스트 메시지로 결과를 알려줍니다
  3. Git Commit (선택)
    "🚀 서버 배포" 버튼 옆의 "▼" 버튼을 클릭하여 "배포 + Commit"을 선택할 수 있습니다. Git Commit을 하려면: 1. Git 사용자 이름과 이메일 입력 2. 커밋 메시지 입력 3. "🚀 배포 + Commit" 버튼 클릭
주의사항
  • 서버 배포는 현재 열려있는 섹션에 대해서만 수행됩니다.
  • Git Commit도 현재 섹션 파일과 해당 제품의 모든 이미지만 포함됩니다.
  • 배포 전에 동기화 상태를 확인하여 차이점이 없는지 확인하는 것을 권장합니다.
04

팁 및 고급 기능

Manual Editor를 더 효율적으로 사용하기 위한 팁과 고급 기능을 안내합니다.

키보드 단축키

Manual Editor에서 사용할 수 있는 키보드 단축키를 안내합니다.

단축키기능설명
Ctrl + S저장현재 파일 저장 (자동 저장과 동일)
Ctrl + Z실행 취소YAML 모드에서만 사용 가능
Ctrl + Y다시 실행YAML 모드에서만 사용 가능
Ctrl + F찾기YAML 모드에서 텍스트 검색

Markdown 서식 사용하기

텍스트 필드에서 Markdown 문법을 사용하여 서식을 적용할 수 있습니다.

지원하는 Markdown 문법
  • 굵게: **텍스트**
  • 기울임: *텍스트*
  • 코드: ` 코드 `
  • 취소선: ~~텍스트~~
  • 링크: [텍스트](https://...)
  • 키보드: {{kbd:Ctrl+S}}
  • 아이콘: {{icon:house}}

콘텐츠 삭제하기

섹션, 서브섹션, 콘텐츠를 삭제하는 방법을 안내합니다.

삭제 확인
모든 삭제 작업은 확인 모달이 표시됩니다.
  • 섹션 삭제: 사이드바의 🗑️ 버튼
  • 서브섹션 삭제: 서브섹션 헤더의 🗑️ 버튼
  • 콘텐츠 삭제: 콘텐츠 항목의 🗑️ 버튼
  • Step 삭제: Step Guide 내 Step의 🗑️ 버튼
삭제는 되돌릴 수 없으므로 주의하세요.

모범 사례

Manual Editor를 효율적으로 사용하기 위한 모범 사례를 안내합니다.

권장 사항
1. 작은 단위로 편집: 한 번에 너무 많은 변경을 하지 말고, 섹션별로 나누어 편집하세요. 2. 자동 저장 활용: 2초 대기 후 자동 저장되므로, 저장 버튼을 누를 필요가 없습니다. 3. 미리보기 확인: Form 모드의 오른쪽 미리보기를 활용하여 실시간으로 결과를 확인하세요. 4. 동기화 상태 확인: 배포 전에 동기화 상태 아이콘을 확인하여 차이점이 없는지 확인하세요. 5. 이미지 최적화: 업로드 전에 이미지를 적절한 크기로 최적화하세요. 6. 다국어 입력: ko, en은 필수이므로 반드시 입력하세요.