%20(1).png)
ComfyUI Nodes Docs 插件完全教程
1. 插件简介
插件地址： https://github.com/CavinHuang/comfyui-nodes-docs
这个插件就像是一个"超级百科全书"！它为ComfyUI提供了一个强大的文档系统，包含了1900+个节点的详细说明文档。想象一下，当你在使用ComfyUI时遇到不认识的节点，就像看到不认识的汉字一样困惑，这个插件就是你的"字典"，能告诉你每个节点是干什么用的、怎么用、有什么参数。
主要功能：
- 📚 节点文档查看：为每个节点显示详细的使用说明
- ✏️ 文档编辑：可以修改和完善节点文档
- 💾 文档导入导出：支持文档的备份和分享
- 🌐 云端同步：支持将本地修改同步到云端
- 🎯 智能显示：在节点上显示文档图标，点击即可查看
能给我们带来什么效果：
- 不再为不认识的节点发愁
- 快速了解节点的用法和参数
- 提高工作流创建效率
- 学习其他人的节点使用经验
2. 如何安装
方法一：ComfyUI Manager（推荐）
- 打开ComfyUI Manager
- 搜索
comfyui-nodes-docs - 点击安装
- 重启ComfyUI
方法二：Git克隆
cd ComfyUI/custom_nodes/
git clone https://github.com/CavinHuang/comfyui-nodes-docs.git
方法三：comfy-cli
comfy node registry-install comfyui-nodes-docs
安装完成后重启ComfyUI即可使用。
3. 节点详解
特别说明： 这个插件本身不提供任何ComfyUI节点，它是一个纯粹的文档查看和管理工具。它的作用是为其他插件的节点提供文档支持。
4. 功能详解
4.1 文档查看功能
这个功能就像是给每个节点装上了"说明书"。
如何使用：
- 在任何节点的右上角会出现一个📄图标
- 点击这个图标就能看到节点的详细文档
- 文档包含节点的用途、参数说明、使用示例等
文档内容包括：
- 节点名称和分类
- 功能描述
- 输入参数详解
- 输出类型说明
- 使用技巧
- 源代码
4.2 文档编辑功能
这个功能就像是"维基百科"的编辑模式，你可以修改和完善文档内容。
如何使用：
- 打开任何节点的文档窗口
- 点击"编辑"按钮
- 在文本框中修改文档内容
- 点击"保存"按钮保存修改
编辑规则：
- 支持Markdown格式
- 修改会保存到本地缓存
- 可以选择是否同步到云端
4.3 设置功能
插件提供了多个设置选项，就像是"控制面板"。
4.3.1 启用/禁用文档显示
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| comfyui nodes docs enabled | ENABLED_SETTING_KEY | 布尔值 | true | 控制是否显示节点文档图标，就像开关灯一样 | 启用或禁用文档功能 | 在设置中勾选或取消勾选，需要重启生效 |
4.3.2 文档导出功能
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| export docs | 导出按钮 | 按钮 | 点击导出 | 把所有文档打包下载，就像打包行李一样 | 导出本地文档为ZIP文件 | 点击按钮会下载nodes-docs.zip文件 |
4.3.3 文档导入功能
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 文件选择器 | 文件上传 | ZIP文件 | 文档压缩包 | 导入别人分享的文档包，就像安装软件一样 | 导入ZIP格式的文档包 | 选择ZIP文件后自动导入到本地 |
4.3.4 参与共建功能
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| comfyui nodes docs contribute | contribute | 布尔值 | true | 是否把你的文档修改分享给大家，就像贡献知识一样 | 启用云端同步功能 | 勾选后你的修改会上传到云端数据库 |
4.4 服务端功能
插件提供了多个后端接口，就像是"服务员"为前端提供各种服务。
4.4.1 获取节点文档接口
功能： 获取指定节点的文档内容
地址： /customnode/getNodeInfo
用途： 当你点击节点文档图标时，就是调用这个接口获取文档内容
4.4.2 缓存节点文档接口
功能： 将文档缓存到本地
地址： /customnode/cacheNodeInfo
用途： 提高文档加载速度，避免重复下载
4.4.3 更新节点文档接口
功能： 保存修改后的文档内容
地址： /customnode/updateNodeInfo
用途： 当你编辑文档后点击保存时调用
4.4.4 导出文档接口
功能： 导出所有文档为ZIP文件
地址： /customnode/exportNodeInfo
用途： 备份或分享文档
4.4.5 导入文档接口
功能： 导入ZIP格式的文档包
地址： /customnode/importNodeInfo
用途： 恢复备份或导入他人分享的文档
4.4.6 更新设置接口
功能： 保存用户设置
地址： /customnode/updateSetting
用途： 保存各种配置选项
5. 使用技巧和建议
5.1 基础使用技巧
查看文档：
- 每个节点右上角的📄图标就是文档入口
- 文档窗口可以拖拽移动和调整大小
- 支持Markdown格式显示，阅读体验更好
编辑文档：
- 点击"编辑"按钮进入编辑模式
- 支持Markdown语法，可以添加格式化内容
- 编辑后记得点击"保存"按钮
管理文档：
- 定期导出文档作为备份
- 可以导入他人分享的优质文档
- 参与共建可以帮助完善文档库
5.2 高级使用技巧
文档编写规范：
- 使用清晰的标题结构
- 详细说明每个参数的作用
- 提供实际使用示例
- 包含注意事项和常见问题
协作技巧：
- 开启"参与共建"功能
- 修改文档时保持客观和准确
- 添加有用的使用技巧和经验
性能优化：
- 文档会自动缓存到本地，提高加载速度
- 大量文档时建议定期清理缓存
- 网络不好时优先使用本地缓存
6. 常见问题解答
Q: 为什么有些节点没有文档？
A: 这个插件包含1900+节点文档，但ComfyUI生态中的节点数量庞大，可能有些新节点还没有文档。你可以自己编写文档并分享给社区。
Q: 文档显示乱码怎么办？
A: 这通常是编码问题，尝试重新导入文档或检查文档文件的编码格式。
Q: 如何贡献文档？
A: 1）开启"参与共建"功能；2）编辑或创建文档；3）保存后会自动同步到云端；4）也可以通过GitHub提交Pull Request。
Q: 文档窗口太小怎么办？
A: 文档窗口支持拖拽调整大小，拖拽右下角的调整图标即可。
Q: 导出的文档如何使用？
A: 导出的ZIP文件包含所有文档的Markdown文件，可以用任何文本编辑器打开，也可以导入到其他ComfyUI实例中。
Q: 如何关闭文档功能？
A: 在ComfyUI设置中找到"comfyui nodes docs enabled"选项，取消勾选后重启ComfyUI即可。
7. 文档格式说明
插件使用标准的Markdown格式存储文档，每个文档包含以下结构：
# Documentation
- Class name: 节点类名
- Category: 节点分类
- Output node: 是否为输出节点
- Repo Ref: 源码仓库地址
节点功能描述
# Input types
输入参数说明
# Output types
输出类型说明
# Usage tips
使用技巧
# Source code
源代码
8. 开发者信息
作者： 水门Minato & Leo
维护状态： 活跃维护中
更新频率： 定期更新，持续添加新节点文档
社区支持： 支持用户贡献和反馈
9. 版本更新记录
2024-07-04：
- 新增1400+节点文档
- 总文档数量达到3500+
- 主要更新了ComfyUI-MotionDiff、KJNodes、Inspire-Pack等插件的文档
2024-06-14：
- 修复文档中的错误
- 更新layerStyle大部分文档
2024-05-25：
- 增加文档显示开关
- 增加本地文档修改功能
- 增加导出导入功能
- 增加参与共建功能
总结： 这个插件虽然本身不提供ComfyUI节点，但它是ComfyUI生态中非常重要的工具。它就像是一个"知识库管理员"，帮助用户更好地理解和使用各种节点。通过这个插件，新手可以快速学习节点用法，老手可以分享经验，整个社区的知识都能得到积累和传承。记住，好的文档是学习的最佳伙伴！