Add docs for controlnet aux preprocessing nodes

.github/workflows/deploy-docs.yml

@@ -42,15 +42,15 @@ jobs:
         github_token: ${{ secrets.UPDATE_GH_PAGES  }}
         publish_dir: ./docs/site
 
-    - name: Remove existing files on remote server
-      uses: appleboy/ssh-action@master
-      with:
-        host: ${{ secrets.REMOTE_HOST }}
-        username: ${{ secrets.REMOTE_USER }}
-        key: ${{ secrets.SSH_PRIVATE_KEY }}
-        port: ${{ secrets.REMOTE_PORT }}
-        script: |
-          rm -rf ${{ secrets.REMOTE_DEST_PATH }}/../../docs
+    # - name: Remove existing files on remote server
+    #   uses: appleboy/ssh-action@master
+    #   with:
+    #     host: ${{ secrets.REMOTE_HOST }}
+    #     username: ${{ secrets.REMOTE_USER }}
+    #     key: ${{ secrets.SSH_PRIVATE_KEY }}
+    #     port: ${{ secrets.REMOTE_PORT }}
+    #     script: |
+    #       rm -rf ${{ secrets.REMOTE_DEST_PATH }}/../../docs
 
     - name: Deploy via scp
       uses: appleboy/scp-action@master

README.md

@@ -1,8 +1,8 @@
 # BizyAir
 
-
+- [2024/07/11] 🌩️ We release new nodes that can perform ControlNet preprocessing. [BizyAir Controlnet Auxiliary Preprocessors](https://siliconflow.github.io/BizyAir/controlnet-preprocessor/introduce.html)
 - [2024/07/11] 🌩️ We release new nodes, featuring removing image background, photo-quality image generation, and animation super-resolution capabilities.
-- [2024/07/10] 🌩️ We release nodes that support Kolors and LLM(large language models).
+- [2024/07/10] 🌩️ We release nodes that support Kolors and LLM(large language models). [Kolors](https://siliconflow.github.io/BizyAir/kolors/introduce.html)
 
 BizyAir is a collection of [ComfyUI](https://github.com/comfyanonymous/ComfyUI) nodes that help you overcome environmental and hardware limitations, allowing you to more easily generate high-quality content with ComfyUI.
 
@@ -13,15 +13,23 @@ BizyAir is a collection of [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
 ## Table of Contents
 
 - [Features](#features)
+- [Usage](#usage)
 - [Installation](#installation)
 - [Examples](#examples)
-- [Usage](#usage)
 
 
 ## Features
 
 Run ComfyUI anywhere, anytime, without worrying about the environment or hardware requirements.
 
+## Usage
+
+Please see the [Quick Start](https://siliconflow.github.io/BizyAir/getting-started/quick-start.html) page to set up BizyAir.
+
+Make sure to **set your API KEY** for the **first time** use!
+
+![](./docs/docs/getting-started/imgs/how-to-set-key.gif)
+
 ## Installation
 
 You can install BizyAir through several methods: using the ComfyUI Manager, the Comfy CLI, downloading the standalone package for Windows, or by cloning the BizyAir repository into the custom_nodes subdirectory of ComfyUI. 
@@ -70,8 +78,3 @@ https://bizy-air.oss-cn-beijing.aliyuncs.com/new_ComfyUI_windows_portable_nvidia
 ## Examples
 
 There are some workflow examples in the [examples](./examples) directory.
-
-
-## Usage
-
-Please see the [Quick Start](https://siliconflow.github.io/BizyAir/getting-started/quick-start.html) page to set up BizyAir.

docs/docs/controlnet-preprocessor/introduce.md

@@ -0,0 +1,56 @@
+# BizyAir ControlNet Auxiliary Preprocessors
+
+In the workflow of ControlNet, it is usually necessary to have image preprocessing nodes to convert images into Image Prompt that the ControlNet network can use.
+
+BizyAir offers more than 20 ControlNet preprocessing nodes.
+
+![](./imgs/bizyair_controlnet_preprocessors.png)
+
+ They have the following categories.
+
+
+## Line Extractors
+
+- ☁️BizyAir PiDiNet Soft-Edge Lines
+- ☁️BizyAir Canny Edge
+- ☁️BizyAir Binary Lines
+- ☁️BizyAir Scribble Lines
+- ☁️BizyAir M-LSD Lines
+- ☁️BizyAir HED Soft-Edge Lines
+- ☁️BizyAir Fake Scribble Lines (aka scribble_hed)
+- ☁️BizyAir Realistic Lineart"
+
+
+## T2I-Adapter Only
+
+- ☁️BizyAir Color Pallete
+
+## Semantic Segmentation
+
+- ☁️BizyAir UniFormer Segmentor
+- ☁️BizyAir OneFormer COCO Segmentor
+- ☁️BizyAir OneFormer ADE20K Segmentor
+- ☁️BizyAir SAM Segmentor
+
+## Normal and Depth Estimators
+
+- ☁️BizyAir Zoe Depth Map
+- ☁️BizyAir MiDaS Normal Map
+- ☁️BizyAir MiDaS Depth Map
+- ☁️BizyAir LeReS Depth Map (enable boost for leres++)
+- ☁️BizyAir BAE Normal Map
+- ☁️BizyAir Depth Anything V2 - Relative
+- ☁️BizyAir Metric3D Depth Map
+- ☁️BizyAir Metric3D Normal Map
+
+## Face and Pose Estimators
+
+- ☁️BizyAir OpenPose Pose
+- ☁️BizyAir DWPose Estimator
+
+
+## Tile
+
+- ☁️BizyAir Tile
+
+

docs/docs/getting-started/quick-start.md

@@ -2,6 +2,9 @@
 
 ## 1. Setting API Key
 
+!!! note
+    You can get your API KEY from [SiliconCloud](https://cloud.siliconflow.cn/) for free.
+
 For the first use, you need to set your API key using "Set SiliconCloud API Key". Add the "Set SiliconCloud API Key" node and run it(click "Queue Prompt" button). The key changes to "**********", indicating successful operation.
 
 ![](./imgs/how-to-set-key.gif)

docs/docs/kolors/introduce.md

@@ -20,6 +20,6 @@ Here is an example of a image-to-image workflow using Kolors:
 ![](./imgs/bizyair_kolors_img2img.png)
 
 
- The nodes provided by BizyAir are compatible with the nodes provided by (ComfyUI-KwaiKolorsWrapper)[https://github.com/kijai/ComfyUI-KwaiKolorsWrapper], allowing you to freely combine them.
+ The nodes provided by BizyAir are compatible with the nodes provided by [ComfyUI-KwaiKolorsWrapper](https://github.com/kijai/ComfyUI-KwaiKolorsWrapper) , allowing you to freely combine them.
 
  Enjoy.

docs/mkdocs.yml

@@ -103,11 +103,6 @@ nav:
     - Installation: getting-started/installation.md
     - Quick Start: getting-started/quick-start.md
   - Kolors: kolors/introduce.md
+  - Controlnet Preprocessing: controlnet-preprocessor/introduce.md
   - Others: others/index.md
-  # - Controlnet Preprocessing:
-  #   - Line Extraction: controlnet-preprocessing/line-extraction.md
-  #   - T2I Adapter: controlnet-preprocessing/t2i-adapter.md
-  #   - Semantic Segmentation: controlnet-preprocessing/semantic-segmentation.md
-  #   - Normal and Depth Estimation: controlnet-preprocessing/normal-and-depth-estimation.md
-  #   - Face and Pose Detection: controlnet-preprocessing/face-and-pose-detection.md
-  #   - Others: controlnet-preprocessing/others.md
+