Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions custom-nodes/help_page.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Help Page"
title: "Add node docs for your ComfyUI custom node"
sidebarTitle: "Node docs"
description: "How to create rich documentation for your custom nodes"
---

Expand All @@ -7,12 +8,12 @@

Custom nodes can include rich markdown documentation that will be displayed in the UI instead of the generic node description. This provides users with detailed information about your node's functionality, parameters, and usage examples.

If you have already added tooltips for each parameter in the node definition, this basic information can be directly accessed via the node documentation panel.

Check warning on line 11 in custom-nodes/help_page.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/help_page.mdx#L11

Did you really mean 'tooltips'?
No additional node documentation needs to be added, and you can refer to the related implementation of [ContextWindowsManualNode](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy_extras/nodes_context_windows.py#L7)

## Setup

To add documentation for your nodes or multi-language support documentation:
To add documentation for your custom nodes or multi-language support documentation:

1. Create a `docs` folder inside your `WEB_DIRECTORY`
2. Add markdown files named after your nodes (the names of your nodes are the dictionary keys in the `NODE_CLASS_MAPPINGS` dictionary used to register the nodes):
Expand Down
7 changes: 4 additions & 3 deletions zh-CN/custom-nodes/help_page.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "帮助页面"
description: "如何为自定义节点创建帮助文档"
title: "为你的 ComfyUI 自定义节点添加节点文档"
sidebarTitle: "节点文档"
description: "如何为内置节点创建帮助文档"
---

## 使用 Markdown 创建节点文档
Expand All @@ -11,7 +12,7 @@ description: "如何为自定义节点创建帮助文档"

## 设置

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

1. 在你的 `WEB_DIRECTORY` 中创建 `docs` 文件夹
2. 添加以节点名称命名的 Markdown 文件(您的节点名称是用于注册节点的 `NODE_CLASS_MAPPINGS` 字典中的字典键):
Expand Down