Skip to content

Commit da50da8

Browse files
Add Node docs section to Interface Guide (#568)
* Update interface/features/node-docs.mdx * Update docs.json * Update docs.json * Update zh-CN/interface/features/node-docs.mdx * Update interface/features/node-docs.mdx * Update English version * Update zh-CN/interface/features/node-docs.mdx * Update zh-CN/interface/features/node-docs.mdx * Fix typos --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <[email protected]>
1 parent 3f6dd8c commit da50da8

File tree

5 files changed

+88
-0
lines changed

5 files changed

+88
-0
lines changed

docs.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
"interface/features/template",
6767
"interface/features/subgraph",
6868
"interface/features/partial-execution",
69+
"interface/features/node-docs",
6970
{
7071
"group": "ComfyUI Settings",
7172
"icon": "gear",
@@ -671,6 +672,7 @@
671672
"zh-CN/interface/features/template",
672673
"zh-CN/interface/features/subgraph",
673674
"zh-CN/interface/features/partial-execution",
675+
"zh-CN/interface/features/node-docs",
674676
{
675677
"group": "ComfyUI 设置",
676678
"icon": "gear",
298 KB
Loading
221 KB
Loading

interface/features/node-docs.mdx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Node docs - View documentation for any node"
3+
description: "Learn how to access built-in documentation for nodes in ComfyUI, including both built-in and custom nodes."
4+
sidebarTitle: "Node docs"
5+
icon: "book-open"
6+
---
7+
8+
Node docs provide quick access to documentation for any node in your workflow. You can view detailed information about a node's functionality, parameters, and usage examples directly within ComfyUI.
9+
10+
## How to view node docs
11+
12+
![Node docs](/images/interface/features/nod-docs/node-docs-1.jpg)
13+
14+
1. **Select a node:**
15+
Click on any node in your workflow to select it.
16+
17+
2. **Open node docs:**
18+
Click the node info icon in the selection toolbox to open the node documentation page.
19+
20+
3. **Exit node docs:**
21+
If you want to exit the node docs, you can click the arrow icon in the top left corner to exit the node docs.
22+
23+
You can also access the node docs via the node library, hover on a node then click the "?" icon to open the node docs.
24+
25+
![Node docs](/images/interface/features/nod-docs/node-docs-2.jpg)
26+
27+
28+
## Built-in node documentation
29+
30+
Documentation for ComfyUI's built-in nodes is maintained in the [embedded-docs repository](https://github.com/Comfy-Org/embedded-docs).
31+
32+
**Contributing to built-in node docs:**
33+
- Users can contribute improvements and additions to built-in node documentation
34+
- Submit pull requests to the [embedded-docs repository](https://github.com/Comfy-Org/embedded-docs)
35+
- Help improve documentation quality for the entire ComfyUI community
36+
37+
## Custom node documentation
38+
39+
Custom nodes can also include their own documentation. When custom node authors provide documentation, it will automatically appear in the node docs panel when you select their nodes.
40+
41+
<Card title="Developer guide: Adding node docs" icon="code" href="/custom-nodes/help_page">
42+
Learn how to create rich documentation for your custom nodes
43+
</Card>
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "节点文档 - 查看任何节点的文档"
3+
description: "了解如何在 ComfyUI 中访问节点的内置文档,包括内置节点和自定义节点。"
4+
sidebarTitle: "节点文档"
5+
icon: "book-open"
6+
---
7+
8+
节点文档提供了快速访问工作流中任何节点文档的功能。您可以直接在 ComfyUI 中查看有关节点功能、参数和使用示例的详细信息。
9+
10+
## 如何查看节点文档
11+
12+
![节点文档](/images/interface/features/nod-docs/node-docs-1.jpg)
13+
14+
1. **选择节点:**
15+
点击工作流中的任何节点以选择它。
16+
17+
2. **打开节点文档:**
18+
点击选择工具箱中的节点信息图标以打开节点文档页面。
19+
20+
3. **退出节点文档:**
21+
如果您想退出节点文档,可以点击左上角的箭头图标退出节点文档。
22+
23+
您也可以通过节点库访问节点文档,将鼠标悬停在节点上,然后点击"?"图标打开节点文档。
24+
25+
![节点文档](/images/interface/features/nod-docs/node-docs-2.jpg)
26+
27+
28+
## 内置节点文档
29+
30+
ComfyUI 内置节点的文档维护在 [embedded-docs 仓库](https://github.com/Comfy-Org/embedded-docs)中。
31+
32+
**为内置节点文档做贡献:**
33+
- 用户可以为内置节点文档贡献改进和补充
34+
-[embedded-docs 仓库](https://github.com/Comfy-Org/embedded-docs)提交拉取请求
35+
- 帮助改善整个 ComfyUI 社区的文档质量
36+
37+
## 自定义节点文档
38+
39+
自定义节点也可以包含自己的文档。当自定义节点作者提供文档时,当您选择他们的节点时,文档将自动显示在节点文档面板中。
40+
41+
<Card title="开发者指南:添加节点文档" icon="code" href="/zh-CN/custom-nodes/help_page">
42+
了解如何为您的自定义节点创建丰富的文档
43+
</Card>

0 commit comments

Comments
 (0)