Compare commits
2 Commits
docs/js-re
...
docs/docs-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f367d0b12d | ||
|
|
b7f60c8c26 |
41
docs/README.md
Normal file
41
docs/README.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# ComfyUI-Manager: Documentation
|
||||||
|
|
||||||
|
This directory contains documentation for the ComfyUI-Manager, providing guides and tutorials for users in multiple languages.
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
The documentation is organized into language-specific directories:
|
||||||
|
|
||||||
|
- **en/**: English documentation
|
||||||
|
- **ko/**: Korean documentation
|
||||||
|
|
||||||
|
## Core Documentation Files
|
||||||
|
|
||||||
|
### Command-Line Interface
|
||||||
|
|
||||||
|
- **cm-cli.md**: Documentation for the ComfyUI-Manager Command Line Interface (CLI), which allows using manager functionality without the UI.
|
||||||
|
|
||||||
|
### Advanced Features
|
||||||
|
|
||||||
|
- **use_aria2.md**: Guide for using the aria2 download accelerator with ComfyUI-Manager for faster model downloads.
|
||||||
|
|
||||||
|
## Documentation Standards
|
||||||
|
|
||||||
|
The documentation follows these standards:
|
||||||
|
|
||||||
|
1. **Markdown Format**: All documentation is written in Markdown for easy rendering on GitHub and other platforms
|
||||||
|
2. **Language-specific Directories**: Content is separated by language to facilitate localization
|
||||||
|
3. **Feature-focused Documentation**: Each major feature has its own documentation file
|
||||||
|
4. **Updated with Releases**: Documentation is kept in sync with software releases
|
||||||
|
|
||||||
|
## Contributing to Documentation
|
||||||
|
|
||||||
|
When contributing new documentation:
|
||||||
|
|
||||||
|
1. Place files in the appropriate language directory
|
||||||
|
2. Use clear, concise language appropriate for the target audience
|
||||||
|
3. Include examples where helpful
|
||||||
|
4. Consider adding screenshots or diagrams for complex features
|
||||||
|
5. Maintain consistent formatting with existing documentation
|
||||||
|
|
||||||
|
This documentation directory will continue to grow to support the expanding feature set of ComfyUI-Manager.
|
||||||
50
js/README.md
50
js/README.md
@@ -1,50 +0,0 @@
|
|||||||
# ComfyUI-Manager: Frontend (js)
|
|
||||||
|
|
||||||
This directory contains the JavaScript frontend implementation for ComfyUI-Manager, providing the user interface components that interact with the backend API.
|
|
||||||
|
|
||||||
## Core Components
|
|
||||||
|
|
||||||
- **comfyui-manager.js**: Main entry point that initializes the manager UI and integrates with ComfyUI.
|
|
||||||
- **custom-nodes-manager.js**: Implements the UI for browsing, installing, and managing custom nodes.
|
|
||||||
- **model-manager.js**: Handles the model management interface for downloading and organizing AI models.
|
|
||||||
- **components-manager.js**: Manages reusable workflow components system.
|
|
||||||
- **snapshot.js**: Implements the snapshot system for backing up and restoring installations.
|
|
||||||
|
|
||||||
## Sharing Components
|
|
||||||
|
|
||||||
- **comfyui-share-common.js**: Base functionality for workflow sharing features.
|
|
||||||
- **comfyui-share-copus.js**: Integration with the ComfyUI Opus sharing platform.
|
|
||||||
- **comfyui-share-openart.js**: Integration with the OpenArt sharing platform.
|
|
||||||
- **comfyui-share-youml.js**: Integration with the YouML sharing platform.
|
|
||||||
|
|
||||||
## Utility Components
|
|
||||||
|
|
||||||
- **cm-api.js**: Client-side API wrapper for communication with the backend.
|
|
||||||
- **common.js**: Shared utilities and helper functions used across the frontend.
|
|
||||||
- **node_fixer.js**: Utilities for fixing disconnected links and repairing malformed nodes by recreating them while preserving connections.
|
|
||||||
- **popover-helper.js**: UI component for popup tooltips and contextual information.
|
|
||||||
- **turbogrid.esm.js**: Grid component library - https://github.com/cenfun/turbogrid
|
|
||||||
- **workflow-metadata.js**: Handles workflow metadata parsing, validation and cross-repository compatibility including versioning, dependencies tracking, and resource management.
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
The frontend follows a modular component-based architecture:
|
|
||||||
|
|
||||||
1. **Integration Layer**: Connects with ComfyUI's existing UI system
|
|
||||||
2. **Manager Components**: Individual functional UI components (node manager, model manager, etc.)
|
|
||||||
3. **Sharing Components**: Platform-specific sharing implementations
|
|
||||||
4. **Utility Layer**: Reusable UI components and helpers
|
|
||||||
|
|
||||||
## Implementation Details
|
|
||||||
|
|
||||||
- The frontend integrates directly with ComfyUI's UI system through `app.js`
|
|
||||||
- Dialog-based UI for most manager functions to avoid cluttering the main interface
|
|
||||||
- Asynchronous API calls to handle backend operations without blocking the UI
|
|
||||||
|
|
||||||
## Styling
|
|
||||||
|
|
||||||
CSS files are included for specific components:
|
|
||||||
- **custom-nodes-manager.css**: Styling for the node management UI
|
|
||||||
- **model-manager.css**: Styling for the model management UI
|
|
||||||
|
|
||||||
This frontend implementation provides a comprehensive yet user-friendly interface for managing the ComfyUI ecosystem.
|
|
||||||
Reference in New Issue
Block a user