diff --git a/docs.json b/docs.json index 890c67b4..4c05173b 100644 --- a/docs.json +++ b/docs.json @@ -66,6 +66,7 @@ "interface/features/template", "interface/features/subgraph", "interface/features/partial-execution", + "interface/features/node-docs", { "group": "ComfyUI Settings", "icon": "gear", @@ -671,6 +672,7 @@ "zh-CN/interface/features/template", "zh-CN/interface/features/subgraph", "zh-CN/interface/features/partial-execution", + "zh-CN/interface/features/node-docs", { "group": "ComfyUI 设置", "icon": "gear", diff --git a/images/interface/features/nod-docs/node-docs-1.jpg b/images/interface/features/nod-docs/node-docs-1.jpg new file mode 100644 index 00000000..4943b064 Binary files /dev/null and b/images/interface/features/nod-docs/node-docs-1.jpg differ diff --git a/images/interface/features/nod-docs/node-docs-2.jpg b/images/interface/features/nod-docs/node-docs-2.jpg new file mode 100644 index 00000000..a71085aa Binary files /dev/null and b/images/interface/features/nod-docs/node-docs-2.jpg differ diff --git a/interface/features/node-docs.mdx b/interface/features/node-docs.mdx new file mode 100644 index 00000000..74506dc6 --- /dev/null +++ b/interface/features/node-docs.mdx @@ -0,0 +1,43 @@ +--- +title: "Node docs - View documentation for any node" +description: "Learn how to access built-in documentation for nodes in ComfyUI, including both built-in and custom nodes." +sidebarTitle: "Node docs" +icon: "book-open" +--- + +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. + +## How to view node docs + +![Node docs](/images/interface/features/nod-docs/node-docs-1.jpg) + +1. **Select a node:** + Click on any node in your workflow to select it. + +2. **Open node docs:** + Click the node info icon in the selection toolbox to open the node documentation page. + +3. **Exit node docs:** + If you want to exit the node docs, you can click the arrow icon in the top left corner to exit the node docs. + +You can also access the node docs via the node library, hover on a node then click the "?" icon to open the node docs. + +![Node docs](/images/interface/features/nod-docs/node-docs-2.jpg) + + +## Built-in node documentation + +Documentation for ComfyUI's built-in nodes is maintained in the [embedded-docs repository](https://github.com/Comfy-Org/embedded-docs). + +**Contributing to built-in node docs:** +- Users can contribute improvements and additions to built-in node documentation +- Submit pull requests to the [embedded-docs repository](https://github.com/Comfy-Org/embedded-docs) +- Help improve documentation quality for the entire ComfyUI community + +## Custom node documentation + +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. + + + Learn how to create rich documentation for your custom nodes + diff --git a/zh-CN/interface/features/node-docs.mdx b/zh-CN/interface/features/node-docs.mdx new file mode 100644 index 00000000..c35e53dc --- /dev/null +++ b/zh-CN/interface/features/node-docs.mdx @@ -0,0 +1,43 @@ +--- +title: "节点文档 - 查看任何节点的文档" +description: "了解如何在 ComfyUI 中访问节点的内置文档,包括内置节点和自定义节点。" +sidebarTitle: "节点文档" +icon: "book-open" +--- + +节点文档提供了快速访问工作流中任何节点文档的功能。您可以直接在 ComfyUI 中查看有关节点功能、参数和使用示例的详细信息。 + +## 如何查看节点文档 + +![节点文档](/images/interface/features/nod-docs/node-docs-1.jpg) + +1. **选择节点:** + 点击工作流中的任何节点以选择它。 + +2. **打开节点文档:** + 点击选择工具箱中的节点信息图标以打开节点文档页面。 + +3. **退出节点文档:** + 如果您想退出节点文档,可以点击左上角的箭头图标退出节点文档。 + +您也可以通过节点库访问节点文档,将鼠标悬停在节点上,然后点击"?"图标打开节点文档。 + +![节点文档](/images/interface/features/nod-docs/node-docs-2.jpg) + + +## 内置节点文档 + +ComfyUI 内置节点的文档维护在 [embedded-docs 仓库](https://github.com/Comfy-Org/embedded-docs)中。 + +**为内置节点文档做贡献:** +- 用户可以为内置节点文档贡献改进和补充 +- 向 [embedded-docs 仓库](https://github.com/Comfy-Org/embedded-docs)提交拉取请求 +- 帮助改善整个 ComfyUI 社区的文档质量 + +## 自定义节点文档 + +自定义节点也可以包含自己的文档。当自定义节点作者提供文档时,当您选择他们的节点时,文档将自动显示在节点文档面板中。 + + + 了解如何为您的自定义节点创建丰富的文档 +