docs: add MkDocs documentation site with GitHub Pages support

- Setup MkDocs Material theme with i18n support
- Add comprehensive documentation in English and Chinese
- Configure GitHub Actions for automatic deployment
- Include guides for installation, usage, DSL, API reference, and more

Author: puke3615

.github/workflows/deploy-docs.yml

@@ -0,0 +1,39 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - '.github/workflows/deploy-docs.yml'
+  workflow_dispatch:  # Allow manual trigger
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          
+      - name: Install dependencies
+        run: |
+          pip install mkdocs-material mkdocs-static-i18n
+          
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force --clean --verbose
+

.gitignore

@@ -51,3 +51,6 @@ quick_test.py
 # Keep important files
 !LICENSE
 !README.md
+
+# MkDocs build output
+site/

docs/en/api-reference.md

@@ -0,0 +1,113 @@
+# API Reference
+
+Complete API reference for ComfyKit.
+
+## ComfyKit Class
+
+### Constructor
+
+```python
+class ComfyKit:
+    def __init__(
+        self,
+        # Local ComfyUI configuration
+        comfyui_url: Optional[str] = None,
+        executor_type: Literal["http", "websocket"] = "http",
+        api_key: Optional[str] = None,
+        cookies: Optional[str] = None,
+        
+        # RunningHub cloud configuration
+        runninghub_url: Optional[str] = None,
+        runninghub_api_key: Optional[str] = None,
+        runninghub_timeout: int = 300,
+        runninghub_retry_count: int = 3,
+    )
+```
+
+### execute Method
+
+```python
+async def execute(
+    self,
+    workflow: Union[str, Path],
+    params: Optional[Dict[str, Any]] = None,
+) -> ExecuteResult
+```
+
+**Parameters:**
+- `workflow`: Workflow source (file path, URL, or RunningHub ID)
+- `params`: Workflow parameters
+
+**Returns:**
+- `ExecuteResult`: Structured execution result
+
+### execute_json Method
+
+```python
+async def execute_json(
+    self,
+    workflow_json: Dict[str, Any],
+    params: Optional[Dict[str, Any]] = None,
+) -> ExecuteResult
+```
+
+**Parameters:**
+- `workflow_json`: Workflow JSON dictionary
+- `params`: Workflow parameters
+
+**Returns:**
+- `ExecuteResult`: Structured execution result
+
+## ExecuteResult Class
+
+```python
+class ExecuteResult:
+    status: str                           # "completed" or "failed"
+    prompt_id: Optional[str]              # Prompt ID
+    duration: Optional[float]             # Duration in seconds
+    
+    # Media outputs
+    images: List[str]                     # All image URLs
+    videos: List[str]                     # All video URLs
+    audios: List[str]                     # All audio URLs
+    texts: List[str]                      # All text outputs
+    
+    # Grouped by variable name
+    images_by_var: Dict[str, List[str]]   # Images by variable
+    videos_by_var: Dict[str, List[str]]   # Videos by variable
+    audios_by_var: Dict[str, List[str]]   # Audios by variable
+    texts_by_var: Dict[str, List[str]]    # Texts by variable
+    
+    # Raw outputs
+    outputs: Optional[Dict[str, Any]]     # Raw output data
+    msg: Optional[str]                    # Error message (if failed)
+```
+
+## Usage Example
+
+```python
+import asyncio
+from comfykit import ComfyKit
+
+async def main():
+    # Initialize
+    kit = ComfyKit()
+    
+    # Execute workflow
+    result = await kit.execute("workflow.json", {
+        "prompt": "a cute cat"
+    })
+    
+    # Access results
+    print(f"Status: {result.status}")
+    print(f"Images: {result.images}")
+    print(f"Duration: {result.duration}s")
+
+asyncio.run(main())
+```
+
+## Next Steps
+
+- Check out complete [Examples](examples.md)
+- Learn about [Configuration](configuration.md)
+

docs/en/configuration.md

@@ -0,0 +1,90 @@
+# Configuration
+
+ComfyKit configuration guide.
+
+## Configuration Priority
+
+ComfyKit uses the following priority for configuration:
+
+1. **Constructor parameters** (highest priority)
+2. **Environment variables**
+3. **Default values**
+
+## Local ComfyUI Configuration
+
+```python
+kit = ComfyKit(
+    # ComfyUI server URL
+    comfyui_url="http://127.0.0.1:8188",  # Default
+    
+    # Execution mode: http (recommended) or websocket
+    executor_type="http",  # Default
+    
+    # API Key (if ComfyUI requires authentication)
+    api_key="your-api-key",
+    
+    # Cookies (if needed)
+    cookies="session=abc123"
+)
+```
+
+## RunningHub Cloud Configuration
+
+```python
+kit = ComfyKit(
+    # RunningHub API URL
+    runninghub_url="https://www.runninghub.ai",  # Default
+    
+    # RunningHub API Key (required)
+    runninghub_api_key="rh-key-xxx",
+    
+    # Timeout (seconds)
+    runninghub_timeout=300,  # Default: 5 minutes
+    
+    # Retry count
+    runninghub_retry_count=3  # Default: 3 retries
+)
+```
+
+## Environment Variables
+
+```bash
+# ComfyUI configuration
+export COMFYUI_BASE_URL="http://127.0.0.1:8188"
+export COMFYUI_EXECUTOR_TYPE="http"
+export COMFYUI_API_KEY="your-api-key"
+export COMFYUI_COOKIES="session=abc123"
+
+# RunningHub configuration
+export RUNNINGHUB_BASE_URL="https://www.runninghub.ai"
+export RUNNINGHUB_API_KEY="rh-key-xxx"
+export RUNNINGHUB_TIMEOUT="300"
+export RUNNINGHUB_RETRY_COUNT="3"
+```
+
+## Complete Example
+
+```python
+from comfykit import ComfyKit
+
+# All parameters
+kit = ComfyKit(
+    # Local ComfyUI
+    comfyui_url="http://127.0.0.1:8188",
+    executor_type="http",
+    api_key="your-api-key",
+    cookies="session=abc123",
+    
+    # RunningHub
+    runninghub_url="https://www.runninghub.ai",
+    runninghub_api_key="rh-key-xxx",
+    runninghub_timeout=300,
+    runninghub_retry_count=3,
+)
+```
+
+## Next Steps
+
+- Learn about [Usage](usage/basic.md)
+- Check [API Reference](api-reference.md)
+

docs/en/contributing.md

@@ -0,0 +1,41 @@
+# Contributing
+
+Contributions are welcome! Please check [Issues](https://github.com/puke3615/ComfyKit/issues) for areas that need help.
+
+## Contribution Process
+
+1. Fork this repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/puke3615/ComfyKit.git
+cd ComfyKit
+
+# Install dependencies
+uv sync --extra dev
+
+# Run tests
+pytest
+
+# Format code
+ruff format
+ruff check --fix
+```
+
+## Guidelines
+
+- Write tests for new features
+- Follow existing code style
+- Update documentation
+- Add examples if needed
+
+## Questions?
+
+Feel free to open an issue for discussion!
+

docs/en/development.md

@@ -0,0 +1,40 @@
+# Development
+
+Guide for ComfyKit development.
+
+## Install Development Dependencies
+
+```bash
+uv sync --extra dev
+```
+
+## Run Tests
+
+```bash
+pytest
+```
+
+## Code Formatting
+
+```bash
+ruff check --fix
+ruff format
+```
+
+## Project Structure
+
+```
+ComfyKit/
+├── comfykit/           # Main package
+│   ├── comfyui/        # ComfyUI integration
+│   └── utils/          # Utilities
+├── examples/           # Example scripts
+├── workflows/          # Example workflows
+└── tests/              # Test suite
+```
+
+## Next Steps
+
+- Check [Contributing](contributing.md) guide
+- Read [API Reference](api-reference.md)
+