为你的 ComfyUI 自定义节点添加节点文档

如何为内置节点创建帮助文档

使用 Markdown 创建节点文档

自定义节点可以使用 Markdown 来创建富文本文档，这些文档信息将在 UI 中显示，取代常见的节点描述信息。可以为用户提供关于节点功能、参数和使用示例的详细信息。

如果你在节点的相关描述信息中已经添加的每个参数的说明信息（tooltip），那么这些基础信息可以被节点文档面板直接获取，而无需再额外添加节点文档，你可以参考 ContextWindowsManualNode 的相关实现。

设置

为你的自定义节点添加节点文档或多语言支持的节点文档：

1. 在你的 WEB_DIRECTORY 中创建 docs 文件夹
2. 添加以节点名称命名的 Markdown 文件（您的节点名称是用于注册节点的 NODE_CLASS_MAPPINGS 字典中的字典键）：
3. WEB_DIRECTORY/docs/NodeName.md - 默认文档
4. WEB_DIRECTORY/docs/NodeName/en.md - 英文文档
5. WEB_DIRECTORY/docs/NodeName/zh.md - 中文文档
6. 根据需要添加其他语言版本（例如 fr.md、de.md 等）

系统将根据用户的语言设置自动加载相应的文档，如果没有本地化版本，则回退到 NodeName.md。

支持的 Markdown 功能

• 标准 Markdown 语法（标题、列表、代码块等）
• 使用 Markdown 语法的图片：![替代文本](image.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           # 中文版本

示例 Markdown 文件

# 我的自定义节点

此节点使用高级算法处理图像。

## 参数

- **image**: 要处理的输入图像
- **strength**: 处理强度 (0.0 - 1.0)

## 用法

![使用示例](example.png)

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