feat: 增加文档说明
This commit is contained in:
@@ -11,3 +11,39 @@ This is the documentation for the comfyUI every nodes.
|
||||
- Restart ComfyUI
|
||||
|
||||
## development
|
||||
|
||||
### fork the repo
|
||||
|
||||
- Fork the repo to your own github account
|
||||
- Create a new branch for your changes and make the changes
|
||||
- Create a pull request to the main repo
|
||||
|
||||
### add a new node docs
|
||||
|
||||
- Create a Markdown file named after the `node type` in the 'docs' folder, such as `CLIPMergeSimple.md`
|
||||
- Add the following structure to the file, please refer to specific examples(CLIPMergeSimple.md)[docs/CLIPMergeSimple.md] for details.:
|
||||
|
||||
<pre><code>
|
||||
# Documentation
|
||||
- Class name: Node name
|
||||
- Category: Node category
|
||||
- Output node: False
|
||||
- Repo Ref: https://github.com/xxxx
|
||||
|
||||
Description of nodes
|
||||
|
||||
# Input types
|
||||
|
||||
Node input types
|
||||
|
||||
# Output types
|
||||
|
||||
Node output types
|
||||
|
||||
# Usage tips
|
||||
- Infra type: GPU
|
||||
|
||||
# Source code
|
||||
|
||||
Node source code
|
||||
</code></pre>
|
||||
Reference in New Issue
Block a user