Skip to content

Commit 8d91f09

Browse files
ZiYao00claude
andcommitted
docs(readme): rebuild both editions, correct the Transparent Title name (T-053)
Rebuilt from the maintainer's drafted bilingual pair, corrected against the repository. The draft was accurate on features (every claim checked against the code, including Dissolve / Flatten All, collision auto-numbering, and the group gestures) but wrong on three points: - It dropped credits for the four referenced open-source projects, the third-party license pointers, the developer-doc index, the CHANGELOG and ROADMAP links, the settings section, and the maintainer's own note about delayed replies. Credits and license pointers are an attribution obligation, so all of it is restored. - It listed WK Groups as a fourth sidebar tab beside the three real ones. Groups are a canvas feature, and the content audit forbids presenting an optional or compatible tab as a fixed fourth built-in. - It used the new Chinese product name before that rename was decided. That matched intent, so the branding doc moved to the draft rather than back. Correct a long-standing factual error found while placing the new cover: both READMEs called the annotation node "Title2", but its display name in ComfyUI's menu is "Transparent Title(透明标题)" under the WorkspaceKit category. A reader following the README would look for a menu entry that does not exist. Both sections are renamed and now state where to find it. English stays the default README. Making Chinese the default was implemented and then reversed on request, because pyproject's `readme` field ships README.md as the Comfy Registry description, and a Chinese listing does not serve a mostly international audience. That round trip exposed a real coupling: release_version.py reads both READMEs by filename and rewrites the release-status line in each, so swapping languages between filenames breaks `--check` immediately. Observed in both directions. The new contract pins the mapping so a future swap fails in the test suite instead of at release time. Drop the five archived screenshot references and place the six covers and three GIFs. Because real GIFs now ship, remove the "GIF tutorials are still being prepared" limitation from both editions. Add scripts/test-readme-surface.mjs, pinning each file's language, the release script's filename mapping, that every local image and link target resolves, the assigned covers and GIFs, the audit's fact boundaries, the archive rule, the node display name against __init__.py, and the absence of the retired Chinese and English product labels across all six renamed surfaces. Verified: 9 images per edition with 0 broken targets, 5 in-page anchors each with 0 missing, suite 89 JS / 6 Python, release check green. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 33be2cf commit 8d91f09

6 files changed

Lines changed: 634 additions & 200 deletions

File tree

‎README.md‎

Lines changed: 225 additions & 142 deletions
Large diffs are not rendered by default.

‎README.zh-CN.md‎

Lines changed: 170 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
1-
# ComfyUI WorkspaceKit(WK)
1+
# ComfyUI WorkspaceKit(WK 面板)
22

33
[English](README.md) · **简体中文**
44

55
> ## ComfyUI 高效率工作区插件
66
>
7-
> **高效管理工作流、节点收藏与节点模板,用更顺手的编组方式整理复杂画布。**
7+
> **集中管理工作流、节点收藏与节点模板,并用更顺手的编组方式整理复杂画布。**
88
99
![Version](https://img.shields.io/badge/version-0.2.5-blue)
1010
![Status](https://img.shields.io/badge/status-public%20beta-orange)
1111
![License](https://img.shields.io/badge/license-MIT-green)
1212

13-
ComfyUI WorkspaceKit(WK,技术仓库名为 `ComfyUI-WorkspaceKit`)的中文正式名是 **WK 工作区**。它是一个面向 ComfyUI 的工作区增强插件,把工作流管理、节点收藏、模板复用和画布整理放进同一个侧边栏入口。
13+
ComfyUI WorkspaceKit(WK)的中文正式名是 **WK 面板**。它把工作流管理、节点收藏、模板复用和画布整理放进同一个侧边栏入口。
14+
15+
`ComfyUI-WorkspaceKit` 仍是仓库、安装目录、Provider API、存储键和 Registry 中使用的技术名称;WK 只用于对外品牌与模块称呼。
1416

1517
当前状态:**公开测试版,0.2.5**。还不是稳定版 1.0;首次在主力环境中使用前,请备份重要工作流、用户设置、节点收藏和模板数据。
1618

19+
![WK 面板总览](Preview/001.jpg)
20+
1721
<p align="center">
1822
<a href="#为什么做成一个工作区">为什么做成一个工作区</a> ·
19-
<a href="#三类工作资产">三类工作资产</a> ·
23+
<a href="#功能说明">功能说明</a> ·
2024
<a href="#安装">安装</a> ·
2125
<a href="#快捷键">快捷键</a> ·
2226
<a href="#数据安全与备份">数据安全</a>
@@ -40,7 +44,13 @@ WorkspaceKit 不替代 ComfyUI 官方界面,也不是把更多按钮堆进侧
4044

4145
首次介绍写作 **ComfyUI WorkspaceKit(WK)**,之后可简称为 **WK**。核心模块统一称为:**WK 工作流、WK 节点、WK 模板、WK 编组**;关联模块称为:**WK 版式、WK 主题**。在已打开的侧边栏内,标签保持简洁,直接显示“工作流|节点|模板|版式|主题”。
4246

43-
`ComfyUI-WorkspaceKit` 仍是仓库、安装目录、Provider API、存储键和 Registry 中使用的技术名称;WK 只用于对外品牌与功能模块称呼。
47+
| 常见问题 | WorkspaceKit 的做法 | 结果 |
48+
| --- | --- | --- |
49+
| 工作流越积越多 | **WK 工作流**:文件夹树、搜索、拖拽、排序、最近记录 | 按项目整理,更快找到文件 |
50+
| 节点难找难记 | **WK 节点**:来源分类、搜索、拼音搜索、收藏分组 | 建立自己的节点库 |
51+
| 常用结构重复搭建 | **WK 模板**:保留节点位置与连线 | 存一次,随时复用 |
52+
| 大型画布看不清 | **WK 编组 + 透明标题** | 更清晰的工作区域与层级 |
53+
| 误删或迁移丢数据 | **两级回收站 + 数据备份迁移** | 恢复、备份和迁移更安全 |
4454

4555
## 三类工作资产
4656

@@ -77,23 +87,68 @@ WorkspaceKit 管理真实的工作流文件,也会保存用户长期积累的
7787
| **缺失节点保留记录** | 第三方节点暂时未安装或加载失败时,以弱化状态显示,不会被静默删除。 |
7888
| **兼容旧存储位置** | 从 Workspace2 升级到 WorkspaceKit 时,继续读取兼容存储位置,保留已有模板数据。 |
7989

90+
删除流程分为两级:
91+
92+
```text
93+
工作流目录
94+
↓ 删除
95+
WK 回收站(可恢复)
96+
↓ 确认清理
97+
系统回收站
98+
```
99+
100+
模板使用独立的可恢复模板回收站,不与工作流回收站混用,也不会写入系统回收站。
101+
102+
![独立回收站与恢复演示](Preview/FileRecovery.gif)
103+
80104
## 功能说明
81105

106+
### WK 编组
107+
108+
![WK 编组](Preview/002.jpg)
109+
110+
WK 编组不是只给节点套一个框,而是把大型工作流中的一片节点变成可选择、可移动、可切换状态、可统一设置样式的区域。
111+
112+
- 选中节点后按 `Ctrl+G` 创建 WK 编组;
113+
- 按 `Shift+G` 解除一个或多个编组框,不删除其中节点和连线;
114+
- 对已选编组按 `Delete`,只删除编组框,节点和连线会保留;
115+
- `Ctrl/Meta + 左键` 点击标题栏:切换整组**忽略**;
116+
- `Alt + 左键` 点击标题栏:切换整组**禁用**;
117+
- `Shift + 左键` 点击标题栏:加入或移出编组多选;
118+
- 双击标题栏:快速选择当前编组、内部节点以及完整嵌套的子编组;
119+
- 在空白画布 `Ctrl + 拖拽`:在 ComfyUI 原生框选基础上同时选择 WK 编组;
120+
- 节点归属贴近 ComfyUI 原生逻辑:节点中心进入编组区域即成为组内节点;
121+
- 鼠标进入编组区域时才显示标题栏操作按钮,减少大型画布上的视觉干扰;
122+
- 支持整组运行状态反馈;没有可执行输出时,执行按钮会弱化显示;
123+
- 右键标题栏打开样式设置,可调整颜色、背景、边框、边距、阴影、透明度、动画与圆角;
124+
- 支持保存常用编组样式预设;
125+
- 支持 WK 编组与 ComfyUI 原生编组之间的颜色兼容与转换;
126+
- 编组数据随工作流一起保存。
127+
128+
如果 `Ctrl+G` 与 ComfyUI 官方快捷键冲突,请修改官方绑定,或在 WorkspaceKit 设置中关闭对应功能。
129+
130+
原生编组转换为 WK 编组:
131+
132+
![原生编组转 WK 编组演示](Preview/GroupConversion.gif)
133+
134+
WK 编组会记住组内节点的状态:
135+
136+
![编组内节点状态记忆演示](Preview/GroupedMemory.gif)
137+
82138
### WK 工作流
83139

140+
![WK 工作流](Preview/003.jpg)
141+
84142
- 默认使用 ComfyUI 官方工作流目录;
85143
- 树状文件夹管理,支持文件夹和子文件夹;
86-
- 新建、重命名、拖拽移动工作流和文件夹;
144+
- 新建、重命名、复制、拖拽移动工作流和文件夹;
87145
- 支持搜索、清空搜索、刷新、排序和自定义顺序;
88146
- 支持最近工作流记录;
89147
- 删除后先进入 WorkspaceKit 回收站,可恢复或移到系统回收站;
90-
- 支持文件夹图标、颜色和自定义顺序;
148+
- 支持文件夹图标与颜色;
91149
- 支持 `Ctrl + 点击` 递归展开或折叠文件夹;
92-
- 支持自定义工作流根目录。
93-
94-
![工作流:目录、排序与拖拽说明](Preview/a1.png)
95-
96-
![工作流:回收站与恢复说明](Preview/a1.1.png)
150+
- 支持自定义工作流根目录;
151+
- 支持直接打开工作流所在位置。
97152

98153
**快捷入口:** `Shift+1` / `Shift+W`
99154

@@ -102,23 +157,64 @@ WorkspaceKit 管理真实的工作流文件,也会保存用户长期积累的
102157
| 新建文件夹 | 在当前浏览位置创建文件夹。 |
103158
| 新建工作流 | 创建空白工作流。 |
104159
| 导入 | 从本地选择并导入工作流。 |
105-
| 排序 | 按名称、修改时间或自定义顺序显示。 |
106-
| 回收站 | 查看、恢复或清理已删除工作流。 |
160+
| 排序 | 按名称、修改时间或自定义顺序显示,可优先显示文件夹。 |
161+
| 回收站 | 查看、恢复或清理已删除工作流;再次点击返回列表。 |
162+
163+
高级用户可以设置自定义工作流根目录。请只选择专门用于存放 ComfyUI 工作流的文件夹,不要选择磁盘根目录、桌面、下载目录或大型项目目录。
164+
165+
#### 解散与全部拍平
166+
167+
文件夹右键菜单提供两种目录整理动作,它们是两个独立操作。
168+
169+
**解散**:只移除当前这一层文件夹,内部文件和子文件夹保留,并整体提升一级。
170+
171+
```text
172+
A/
173+
└─ B/
174+
└─ C/
175+
└─ flow.json
176+
177+
解散 B 后:
178+
179+
A/
180+
└─ C/
181+
└─ flow.json
182+
```
183+
184+
**全部拍平**:移除当前文件夹以及下面所有子文件夹,把内部文件全部提升到上一级。
185+
186+
```text
187+
A/
188+
└─ B/
189+
└─ C/
190+
└─ flow.json
191+
192+
全部拍平 A 后:
193+
194+
flow.json
195+
```
196+
197+
- 两者分开,是为了避免一次误操作破坏整棵手工整理的目录结构;
198+
- 「全部拍平」始终要求确认;
199+
- 遇到同名文件时会自动编号,例如 `工作流(2).json`,扩展名始终保留在最后;
200+
- 同样的整理逻辑也适用于模板分组;
201+
- 更新到包含新后端接口的版本后,请完整重启一次 ComfyUI。
107202

108203
### WK 节点
109204

110-
- 按 **Comfy** 和 **扩展** 区分节点来源;
205+
![WK 节点](Preview/004.jpg)
206+
207+
- 按 **Comfy** 和 **第三方扩展** 区分节点来源;
208+
- 第三方节点按插件来源分组;
111209
- 支持搜索、模糊搜索和拼音搜索;
112-
- 支持收藏节点、收藏分组和收藏子分组;
210+
- 支持收藏根目录、收藏分组和收藏子分组;
113211
- 支持节点拖拽到收藏分组或画布;
114212
- 支持点击节点后再点击画布放置;
115-
- 支持节点预览卡片;
116-
- 支持与 ComfyUI 官方收藏导入 / 导出,写入前自动备份;
117-
- 缺失的第三方节点以弱显示保留;
213+
- 支持完整 / 紧凑两种节点预览;
214+
- 支持与 ComfyUI 官方收藏导入 / 导出、备份和恢复,写入前自动备份;
215+
- 缺失的第三方节点以弱化状态保留,不会被静默删除;
118216
- 支持节点缓存,便于大型节点库更快显示首屏内容。
119217

120-
![节点:收藏与官方收藏同步说明](Preview/a2.png)
121-
122218
**快捷入口:** `Shift+2` / `Shift+N`
123219

124220
| 搜索框右侧按钮 | 作用 |
@@ -130,16 +226,18 @@ WorkspaceKit 管理真实的工作流文件,也会保存用户长期积累的
130226

131227
### WK 模板
132228

229+
![WK 模板](Preview/005.jpg)
230+
231+
模板是已经连接好的节点组合,适合保存加载器、预处理、控制块、输出链等常用结构。
232+
133233
- 使用 `Alt+C` 将当前选中的节点保存为模板;
134234
- 保存模板时保留节点相对位置和连接关系;
135235
- 支持模板拖拽到画布,或单击后再点击画布放置;
136236
- 支持模板分组、子分组、搜索、排序和重命名;
137-
- 支持模板预览、删除、回收站和恢复;
138-
- 支持模板行内重命名按钮及右键菜单。
139-
140-
![模板:预览、重命名与右键菜单说明](Preview/a3.png)
141-
142-
![模板:回收站与恢复说明](Preview/a3.1.jpg)
237+
- 支持模板悬停预览;
238+
- 支持模板行内重命名按钮及右键菜单(重命名、放置到画布中心、删除);
239+
- 删除模板或模板分组前提供行内确认,删除后可从模板回收站恢复;
240+
- 模板分组同样支持「解散 / 全部拍平」。
143241

144242
**快捷入口:** `Shift+3` · **保存模板:** `Alt+C`
145243

@@ -150,24 +248,13 @@ WorkspaceKit 管理真实的工作流文件,也会保存用户长期积累的
150248
| 排序 | 调整模板显示顺序。 |
151249
| 回收站 | 查看、恢复或清理已删除模板。 |
152250

153-
测试阶段为保证兼容性,模板数据仍使用 ComfyUI 用户目录下现有的 Workspace2 兼容存储位置;升级后已有模板数据仍可继续使用。
154-
155-
### WK 编组
156-
157-
- 选中节点后按 `Ctrl+G` 创建 WorkspaceKit 编组;
158-
- 按 `Shift+G` 解除一个或多个编组框,不删除其中节点;
159-
- 按 `Ctrl/Meta + 左键` 切换忽略,按 `Alt + 左键` 切换禁用;
160-
- 按 `Shift + 左键` 将编组加入或移出临时多选;
161-
- 在空白画布 `Ctrl + 拖拽`,可在原生框选中同时选择 WorkspaceKit 编组;
162-
- 对已选编组按 `Delete`,只删除编组框,节点和连线会保留;
163-
- 右击标题栏打开样式设置,可保存常用视觉预设;
164-
- 支持编组边距、边框、阴影、动画等视觉参数。
251+
测试阶段为保证兼容性,模板数据仍使用 ComfyUI 用户目录下现有的 Workspace2 兼容存储位置;升级后已有模板数据仍可继续使用。请定期备份重要模板数据。
165252

166-
如果 `Ctrl+G` 与 ComfyUI 官方快捷键冲突,请修改官方绑定,或在 WorkspaceKit 设置中关闭对应功能。
253+
### 透明标题
167254

168-
### 标题2
255+
![透明标题节点](Preview/006.jpg)
169256

170-
标题2 是一个轻量的画布标题 / 注释节点,适合给大型工作流添加区域标题、说明和视觉分隔。
257+
一个轻量的画布标题 / 注释节点,适合给大型工作流添加区域标题、说明和视觉分隔。在 ComfyUI 节点菜单的 **🧩 WorkspaceKit** 分类下,显示为 **Transparent Title(透明标题)**。
171258

172259
默认样式:
173260

@@ -204,19 +291,6 @@ WorkspaceKit 管理真实的工作流文件,也会保存用户长期积累的
204291
| `Shift + 左键` 编组标题栏 | 加入或移出编组多选。 |
205292
| `Ctrl + 拖拽` 空白画布 | 在原生框选中同时选择 WorkspaceKit 编组。 |
206293

207-
## 数据安全与备份
208-
209-
WorkspaceKit 支持导出和导入插件自身管理的数据,适合迁移节点收藏、模板、文件夹元数据和设置。导入前会自动创建备份;工作流文件和可重新生成的节点缓存不包含在导出包中。
210-
211-
首次在主环境中使用前,建议额外备份:
212-
213-
- ComfyUI 工作流目录;
214-
- ComfyUI 用户设置;
215-
- 重要节点收藏数据;
216-
- 重要模板数据。
217-
218-
高级用户可以设置自定义工作流根目录。请只选择专门用于存放 ComfyUI 工作流的文件夹,不要选择磁盘根目录、桌面、下载目录或大型项目目录。
219-
220294
## 设置
221295

222296
WorkspaceKit 设置集中管理:
@@ -231,6 +305,8 @@ WorkspaceKit 设置集中管理:
231305

232306
关闭某个快捷键后,对应组合键会交还给 ComfyUI 或浏览器。
233307

308+
兼容的外部模块可以通过 Provider API 合并到同一个面板,或者保持独立显示。
309+
234310
## 安装
235311

236312
### 通过 ComfyUI Manager / Registry 安装(推荐)
@@ -256,14 +332,51 @@ python_embeded\python.exe -m pip install -r ComfyUI\custom_nodes\ComfyUI-Workspa
256332

257333
完成后重启 ComfyUI。请确保依赖安装在 ComfyUI 实际使用的 Python 环境中,不要随意更新其它依赖。
258334

335+
### 系统回收站依赖
336+
337+
推荐安装 `send2trash`,可直接使用项目依赖:
338+
339+
```bash
340+
pip install -r requirements.txt
341+
```
342+
343+
Windows 提供内置回收站兜底;其他平台通过 `send2trash` 使用系统回收站能力。
344+
345+
## 数据安全与备份
346+
347+
WorkspaceKit 支持导出和导入插件自身管理的数据,适合迁移:
348+
349+
- 节点收藏;
350+
- 模板数据;
351+
- 文件夹元数据;
352+
- WorkspaceKit 设置。
353+
354+
导入前会自动创建备份。工作流文件本身和可重新生成的节点缓存不包含在导出包中。
355+
356+
WorkspaceKit 会实际执行工作流文件的重命名、移动、文件夹移动、删除、恢复、解散和拍平操作。因此即使已经提供 WK 回收站和系统回收站两层保护,首次在主力环境中使用前,仍建议备份:
357+
358+
- ComfyUI 工作流目录;
359+
- ComfyUI 用户设置;
360+
- 重要节点收藏数据;
361+
- 重要模板数据。
362+
363+
## 五分钟上手
364+
365+
1. 从侧边栏打开 WorkspaceKit,用 `Shift+1`、`Shift+2`、`Shift+3` 在工作流、节点和模板之间切换;
366+
2. 在 WK 工作流中新建一个文件夹,把工作流拖进去;
367+
3. 在 WK 节点中搜索一个常用节点,拖进收藏分组;
368+
4. 在画布上选中已连接的节点,按 `Alt+C` 保存为模板;
369+
5. 选中节点按 `Ctrl+G`,创建第一个 WK 编组。
370+
259371
## 当前状态与已知限制
260372

261373
- 当前仍是公开测试版,不是稳定版 1.0;
262374
- 大型工作流目录的扫描与刷新仍可能较慢;
375+
- 清空回收站到系统回收站时,耗时随项目数量线性增加;
263376
- 超大型节点库中的搜索速度、排序和拼音命中质量仍需继续实测;
264377
- 模板回收站已支持恢复,批量恢复和更完整的撤销体验仍可继续完善;
265-
- README 已提供正式截图,GIF 操作演示仍在补充;
266-
- Registry 已上架,图标、Banner 和教程素材仍可继续完善。
378+
- Registry 已上架,图标、Banner 和教程素材仍可继续完善;
379+
- `main` 分支可能包含尚未进入正式发布的新功能和修复。
267380

268381
## 项目说明
269382

‎docs/DEVELOPMENT_STATUS.zh-CN.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
| 目的 | 文档 |
3131
| --- | --- |
32-
| 安装、功能概览与使用说明 | [README.zh-CN.md](../README.zh-CN.md) / [README.md](../README.md) |
32+
| 安装、功能概览与使用说明 | [README.md](../README.md)(中文,默认)/ [README.en.md](../README.en.md)(English)|
3333
| 未来产品方向 | [ROADMAP.zh-CN.md](../ROADMAP.zh-CN.md) / [ROADMAP.md](ROADMAP.md) |
3434
| 版本历史 | [CHANGELOG.md](../CHANGELOG.md) |
3535
| 贡献、安全与版本规则 | [CONTRIBUTING.md](../CONTRIBUTING.md) / [SECURITY.md](../SECURITY.md) / [RELEASE_VERSIONING.md](RELEASE_VERSIONING.md) |

0 commit comments

Comments
 (0)