# comfyui-doc-generator

> Automatically generate professional documentation from ComfyUI workflow files (PNG or JSON). Supports bilingual output (Chinese/English), HTML generation, and custom node detection.

- Author: Zone-Roam
- Repository: Zone-Roam/ComfyUI-doc-generator
- Version: 20260125150445
- Stars: 2
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/Zone-Roam/ComfyUI-doc-generator
- Web: https://mule.run/skillshub/@@Zone-Roam/ComfyUI-doc-generator~comfyui-doc-generator:20260125150445

---

---
name: comfyui-doc-generator
description: Automatically generate professional documentation from ComfyUI workflow files (PNG or JSON). Supports bilingual output (Chinese/English), HTML generation, and custom node detection.
---

# ComfyUI Workflow Documentation Generator

Generate comprehensive, client-ready documentation for ComfyUI workflows in seconds.

## When to Use This Skill

Use this skill when you need to:
- Generate documentation for a ComfyUI workflow
- Create client delivery documents for AIGC projects
- Document workflow dependencies (models, custom nodes)
- Produce bilingual (Chinese/English) technical documentation

## Usage Examples

**Basic usage (natural language):**
```
Generate documentation for this workflow: /path/to/workflow.png
```

**With HTML output:**
```
Generate documentation with HTML for: /path/to/workflow.png
```

**Chinese only:**
```
Generate Chinese documentation: /path/to/workflow.json
```

## Output

The skill generates:

### Markdown Documentation
- **Workflow Overview**: Purpose, node count, features (LoRA, ControlNet, Upscale)
- **Node Details**: Categorized table of all nodes with descriptions
- **Dependencies**: Required models (checkpoints, LoRAs, VAEs, ControlNet)
- **Custom Nodes**: List with Git installation commands
- **Usage Guide**: Step-by-step instructions
- **FAQ**: Common issues and solutions

### HTML Documentation (Optional)
- Professional dark theme (Red & Black style)
- Responsive design
- Ready for client delivery

## Technical Implementation

The skill uses Python scripts in the `scripts/` directory:

1. **extract_workflow.py**: Extracts workflow JSON from PNG metadata or loads JSON files
2. **parse_workflow.py**: Categorizes nodes and extracts dependencies
3. **generate_doc.py**: Generates Markdown documentation from templates
4. **html_generator.py**: Converts Markdown to styled HTML

## Requirements

- Python 3.7+
- Pillow (for PNG extraction)
- markdown (for HTML generation)

```bash
pip install Pillow markdown
```

## Limitations

- Only supports ComfyUI workflows with standard `nodes` array structure
- Custom node repository URLs may need manual verification for uncommon nodes
- PNG files must have embedded workflow metadata (exported from ComfyUI)

## Examples

See `examples/` directory for sample generated documentation.