메인 콘텐츠로 건너뛰기

마크다운을 이용한 노드 문서 작성

맞춤형 노드는 일반적인 노드 설명 대신 UI에 표시될 풍부한 마크다운 형식의 문서를 포함할 수 있습니다. 이를 통해 사용자들은 노드의 기능, 매개변수 및 사용 예제에 대한 상세한 정보를 얻을 수 있습니다. 노드 정의에서 이미 각 매개변수에 대한 도구팁을 추가했다면, 이 기본 정보는 노드 문서 패널을 통해 바로 접근할 수 있습니다. 추가적인 노드 문서를 별도로 추가할 필요가 없으며, ContextWindowsManualNode의 관련 구현을 참고하시기 바랍니다.

설정

맞춤형 노드 또는 다국어 지원 문서를 추가하려면:
  1. WEB_DIRECTORY 내부에 docs 폴더를 생성하세요.
  2. 노드 이름을 따서 마크다운 파일을 추가하세요(노드 이름은 노드를 등록하는 데 사용되는 NODE_CLASS_MAPPINGS 딕셔너리의 키입니다):
    • WEB_DIRECTORY/docs/노드이름.md - 기본 문서
    • WEB_DIRECTORY/docs/노드이름/en.md - 영어 문서
    • WEB_DIRECTORY/docs/노드이름/zh.md - 중국어 문서
    • 필요한 경우 다른 지역 언어도 추가하세요(예: fr.md, de.md 등)
시스템은 사용자의 지역 설정에 따라 적절한 문서를 자동으로 로드하며, 현지화된 버전이 없을 경우 기본 문서인 노드이름.md로 돌아갑니다.

지원되는 마크다운 기능

  • 표준 마크다운 문법(제목, 목록, 코드 블록 등)
  • 마크다운 문법을 사용한 이미지: ![대체 텍스트](이미지.png)
  • 특정 속성을 가진 HTML 미디어 요소:
    • <video><source> 태그
    • 허용되는 속성: controls, autoplay, loop, muted, preload, poster

예제 구조

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

예제 마크다운 파일

# 나만의 맞춤형 노드

이 노드는 고급 알고리즘을 사용해 이미지를 처리합니다.

## 매개변수

- **image**: 처리할 입력 이미지
- **strength**: 처리 강도 (0.0 - 1.0)

## 사용법

![예시 사용법](example.png)

<video controls loop muted>
  <source src="demo.mp4" type="video/mp4">
</video>