Files
2nd/10_Wiki/Topics/Comfyui/위키 Add node docs for your ComfyUI custom node - ComfyUI 2026-05-20.md
T
koriweb a3f63e56e2 Add ComfyUI wikified docs and youtube extracts; tidy raw→Topics
- 10_Wiki/Comfyui/: ComfyUI docs generated via /wikify
- 00_Raw/_youtube/: /youtube extraction outputs
- Move some 00_Raw originals into 10_Wiki/Topics_meeting; remove empty canvases and stray files

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-20 18:41:10 +09:00

4.6 KiB

id, title, category, status, verification_status, canonical_id, aliases, duplicate_of, source_trust_level, confidence_score, created_at, updated_at, review_reason, merge_history, tags, raw_sources, applied_in, github_commit
id title category status verification_status canonical_id aliases duplicate_of source_trust_level confidence_score created_at updated_at review_reason merge_history tags raw_sources applied_in github_commit
add-node-docs-for-your-comfyui-custom-node---comfyui Add node docs for your ComfyUI custom node - ComfyUI 10_Wiki/Topics draft conceptual
B 0.8 2026-05-20 2026-05-20
web
wikify
https://docs.comfy.org/custom-nodes/help_page

Add node docs for your ComfyUI custom node - ComfyUI

🎯 한 줄 통찰 (One-line insight)

ComfyUI 커스텀 노드 개발자는 마크다운(Markdown) 파일을 활용하여 노드의 기능, 파라미터, 사용법을 포함한 풍부한 문서를 UI 내에 직접 구현할 수 있습니다.

🧠 핵심 개념 (Core concepts)

  • Rich Markdown Documentation: 일반적인 노드 설명을 넘어 HTML 요소와 마크레이 형식을 사용하여 상세한 정보를 사용자에게 제공합니다.
  • Multi-language Support: 언어별(영어, 중국어 등) 폴더 구조를 통해 다국어 문서를 지원하며, 사용자의 로케일에 따라 자동 로드됩니다.
  • Automated Fallback System: 특정 언어의 문서가 없을 경우 기본값인 NodeName.md를 참조하도록 설계되었습니다.
  • Integrated UI Display: 별도의 외부 페이지 없이 ComfyUI 인터페이스 내에서 직접 노드 문서를 확인할 수 있습니다.

🧩 추출된 패턴 (Extracted patterns)

  • 계층적 문서 구조: WEB_DIRECTORY/docs/ 하위에 노드 이름을 따르는 폴더와 파일을 배치하는 정형화된 디렉토리 구조를 가집니다.
  • 확장 가능한 마크다운 기능: 표준 문법 외에도 이미지(![]()) 및 특정 속성을 가진 <video> 태그 등 HTML 요소를 결합하여 풍부한 콘텐츠를 구성합니다.

📖 세부 내용 (Details)

🛠️ Setup (설정 방법)

문서를 추가하기 위해서는 WEB_DIRECTORY 내에 docs 폴더를 생성하고 다음과 같은 규칙으로 파일을 배치해야 합니다.

파일 경로 예시 설명
WEB_DIRECTORY/docs/NodeName.md 기본(Fallback) 문서 (노드 이름은 NODE_CLASS_MESSAGES의 키값과 일치해야 함)
WEB_DIRECTORY/docs/NodeName/en.md 영어 문서
WEB_DIRECTORY/docs/NodeName/zh.md 중국어 문서
기타 로케일 (예: fr.md, de.md) 필요한 언어 추가 가능

📝 Supported Markdown Features (지원되는 마크다운 기능)

  • Standard Syntax: 헤딩(Headings), 리스트(Lists), 코드 블록(Code blocks) 등 표준 문법 지원.
  • Images: ![alt text](image.png) 형식을 통한 이미지 삽입 가능.
  • HTML Media Elements: <video><source> 태그 사용 가능.
    • 허용된 속성: controls, autoplay, loop, muted, preload, poster

📂 Example Structure (디렉토리 구조 예시)

커스텀 노드 패키지 내의 권장 구조는 다음과 같습니다.

my-custom-node/
├── __init__.py
├── web/ # WEB_DIRECTORY
│   ├── js/
│   │   └── my-node.js
│   └── docs/
│       ├── MyNode.md (기본 문서)
│   └── MyNode/
│       ├── en.md (영어 버전)
│       └── zh.md (중국어 버전)

⚖️ 모다 및 업데이트 (Contradictions & updates)

  • 본문 내 정보 간의 상충되는 내용은 발견되지 않았습니다.
  • ContextWindowsManualNode와 관련하여, 이미 파라미터에 툴팁을 추가했다면 추가적인 노드 문서 없이도 정보를 참조할 수 있다는 구현 관련 언급이 있습니다.

🛠️ 적용 사례 (Applied in summary)

  • Example Markdown File: 실제 작성 가능한 마크다운 파일의 예시로, 파라미터(image, strength), 사용법 설명, 이미지 및 비디오 태그가 포함된 구조를 제시하고 있습니다.

검증 상태 및 신뢰도

  • 상태: draft
  • 검증 단계: conceptual
  • 출처 신뢰도: B (Primary Source — 웹사이트 본문 직접 추출)
  • 중복 검사 결과: 신규 생성 (New discovery)
  • ComfyUI : 문서를 적용할 대상인 커스텀 노드 프레임워크입니다.
  • NODE_CLASS_MAPPINGS : 노드를 등록할 때 사용하는 딕셔너리로, 문서 파일명 결정의 기준이 됩니다.
  • WEB_DIRECTORY : 문서 파일이 위치해야 하는 웹 디렉토리 경로를 정의합니다.

📝 변경 이력 (Change history)