Manual Editor
User Manual
Menu configuration may vary or some features may not be supported depending on the product version.
Table of Contents
Getting Started with Manual Editor
Manual Editor is a tool for editing YAML-based manual content and syncing it to Sanity CMS.
Accessing Manual Editor
Learn how to access the Manual Editor.
- Open Manual Editor URL in browserDevelopment:
http://localhost:3010/admin/manual-editorProduction:https://your-domain.com/admin/manual-editor - Select ProductSelect the manual product to edit from the product dropdown in the header.
- Select SectionClick on the section file to edit from the left sidebar.
Editor Modes (YAML / Form)
Manual Editor provides two editing modes.
- View entire file structure at a glance
- Good for quick bulk edits
- Suitable for users familiar with YAML syntax
_product.yamlfiles can only be edited in YAML mode
- Edit with intuitive UI
- Reorder with drag and drop
- Built-in image picker
- Real-time preview
- Only supports section files (excludes
_product.yaml)
Auto-Save Feature
Manual Editor provides auto-save functionality.
- Auto-save after 2 seconds: After editing, if there's no input for 2 seconds, the file is automatically saved.
- Immediate save on section switch: When switching to another section, changes to the current section are saved immediately.
- Save status display: You can check undeployed sections with the yellow dot (🟡) in the sidebar.
Editing Content
Learn how to edit sections, subsections, and content in Form mode — including Document Info and auto subsection TOC.
Adding a New Section
Learn how to create a new section file.
- Click the + buttonClick the "+" button at the top of the sidebar.
- Enter Section InformationEnter the following information in the modal:
- Order: Numbers only (e.g., "3" → number becomes 03 automatically)
- Document Info (unnumbered): Check for release notes, legal notices, etc.
- Slug: Lowercase letters, numbers, and hyphens only (e.g., "new-feature")
- Title: Enter multilingual title
- Creation CompleteClick the ✅ button to create the new section file, which will be automatically selected.
Adding a Subsection
Learn how to add a subsection within a section.
- Click the + Add Subsection buttonIn Form mode, click the "+ Add Subsection" button.
- Enter Subsection InformationEnter the following information for the subsection:
- ID: Unique identifier (e.g., "feature-overview")
- Title: Multilingual title
- Description: Multilingual description (optional)
Adding Content
Learn how to add Step Guide, InfoBox, Screenshot, and Table to subsections.
- Expand SubsectionClick on the subsection to expand it where you want to add content.
- Select Content TypeClick the "+ Add Content" button and select the desired content type.
- Edit ContentEnter the fields according to the selected content type.
Reordering with Drag and Drop
You can reorder subsections and content by dragging and dropping.
- Drag ItemClick and drag the subsection or content item you want to move.
- Drop at Target LocationDrag to the desired location and release the mouse to change the order.
Document Information Area
Use the Document Information area for release notes, legal notices, and open-source licenses. It appears below the Table of Contents on the product cover, without section numbers.
- Open a section file (not _product.yaml)Document Info is not configured in
_product.yaml. Create or open a section YAML file (e.g.,90-release-notes.yaml,08-reference.yaml). - Enable Document Info (unnumbered)In Form mode, open Section Info and check Document Info (unnumbered). Or in YAML mode, set: ``
yaml section: number: "" slug: release-notes order: 90 unnumbered: true title: ko: 릴리즈 노트 en: Release Notes`` - Check the product cover previewAfter save and Sanity sync, the section appears under Document Information on the product cover (below Contents), without a number badge. Numbered chapters stay under Contents; unnumbered sections move to Document Information.
- Select
_product.yamlin the sidebar to preview the cover (Contents + Document Information). - Existing sections like "Reference / Legal Notice" can be moved by enabling Document Info (unnumbered) on that section file.
- Order still controls sort order; only the number display is hidden.
Auto Subsection Table of Contents
When a section has 3 or more subsections, a title-link TOC is generated automatically at the top of the section page.
- Shown only when there are 3 or more subsections
- Lists subsection titles as in-page links
- Clicking a link scrolls to that subsection (
#id) - No manual TOC editing required — titles come from each subsection
feature-overview). The ID is used as the anchor for the link.Image Upload and Deployment
Learn how to upload images and deploy changes to the server.
Uploading Images
Learn how to upload images to Manual Editor.
- Open Image PickerIn Form mode, click the "📷 Select Image" button next to the image field.
- Upload ImageIn the image picker modal: 1. Click the "📤 Upload" button 2. Select the image file to upload 3. After upload completes, select from the image list
- Set Multilingual ImagesIn the image picker, select language tabs (🇰🇷 Korean, 🇺🇸 English, 🇯🇵 Japanese, 🇪🇸 Spanish) to set different images for each language.
Checking Sync Status
Learn how to check the synchronization status between YAML files and Sanity CMS.
- ✅ Synced: YAML and Sanity match
- ⚠️ Has Differences: Some fields differ
- ❌ Not Deployed: Document not in Sanity
- 🔄 Checking: Checking status
- Yellow dot (🟡): Section not deployed to server
- None: Section deployed to server
Deploying to Server
Learn how to sync changes to Sanity CMS and deploy to the server.
- Check ChangesVerify that your edits have been auto-saved. (Auto-saved after 2 seconds or when switching sections)
- Click Server Deployment ButtonClick the "🚀 Server Deployment" button in the header.
- A full-screen loading overlay will appear
- Synchronization to Sanity CMS will proceed
- Results will be shown in a toast message when complete
- Git Commit (Optional)Click the "▼" button next to "🚀 Server Deployment" to select "Deploy + Commit". To perform Git Commit: 1. Enter Git username and email 2. Enter commit message 3. Click "🚀 Deploy + Commit" button
- Server deployment is performed only for the currently open section.
- Git Commit also includes only the current section file and all images for that product.
- It is recommended to check the sync status before deployment to ensure there are no differences.
Tips and Advanced Features
Learn tips and advanced features to use Manual Editor more efficiently.
Keyboard Shortcuts
Learn keyboard shortcuts available in Manual Editor.
| 단축키 | 기능 | 설명 |
|---|---|---|
| Ctrl + S | 저장 | 현재 파일 저장 (자동 저장과 동일) |
| Ctrl + Z | 실행 취소 | YAML 모드에서만 사용 가능 |
| Ctrl + Y | 다시 실행 | YAML 모드에서만 사용 가능 |
| Ctrl + F | 찾기 | YAML 모드에서 텍스트 검색 |
Using Markdown Formatting
You can use Markdown syntax in text fields to apply formatting.
- Bold:
**text** - Italic:
*text* Code: `code`Strikethrough:~~text~~- Link:
[text](https://...) - Keyboard:
{{kbd:Ctrl+S}} - Icon:
{{icon:house}}
Deleting Content
Learn how to delete sections, subsections, and content.
- Delete Section: 🗑️ button in sidebar
- Delete Subsection: 🗑️ button in subsection header
- Delete Content: 🗑️ button in content item
- Delete Step: 🗑️ button in Step Guide step
Best Practices
Learn best practices for using Manual Editor efficiently.
_product.yaml.
8. Subsection IDs: With 3+ subsections, an auto TOC appears at the top — give each subsection a meaningful ID for anchor links.