mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-01-26 19:09:52 +00:00
a505aec037
* docs: Clarify extension terminology and dev server limitations * docs: removed unecessary callout to extension docs in main readme, in favor of the contributions.md * docs: remove key points * docs: change docs structure for better semantics and extensibility * docs: add warning emoji * docs: remove mention of 3D core extensions * docs: add feedback in
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
# ComfyUI Extensions Documentation
|
|
|
|
## Overview
|
|
|
|
Extensions are the primary way to add functionality to ComfyUI. They can be custom nodes, custom nodes that render widgets (UIs made with javascript), ComfyUI shell UI enhancements, and more. This documentation covers everything you need to know about understanding, using, and developing extensions.
|
|
|
|
## Documentation Structure
|
|
|
|
- **[Development Guide](./development.md)** - How to develop extensions, including:
|
|
- Extension architecture and terminology
|
|
- How extensions load (backend vs frontend)
|
|
- Why extensions don't work in dev server
|
|
- Development workarounds and best practices
|
|
|
|
- **[Core Extensions Reference](./core.md)** - Detailed reference for core extensions:
|
|
- Complete list of all core extensions
|
|
- Extension architecture principles
|
|
- Hook execution sequence
|
|
- Best practices for extension development
|
|
|
|
## Quick Links
|
|
|
|
### Key Concepts
|
|
|
|
- **Extension**: Umbrella term for any code that extends ComfyUI
|
|
- **Custom Nodes**: Python backend nodes (a type of extension)
|
|
- **JavaScript Extensions**: Frontend UI enhancements
|
|
- **Core Extensions**: Built-in extensions bundled with ComfyUI
|
|
|
|
### Common Tasks
|
|
|
|
- [Developing extensions in dev mode](./development.md#development-workarounds)
|
|
- [Understanding the shim system](./development.md#how-the-shim-works)
|
|
- [Extension hooks and lifecycle](./core.md#extension-hooks)
|
|
|
|
### External Resources
|
|
|
|
- [Official JavaScript Extension Docs](https://docs.comfy.org/custom-nodes/js/javascript_overview)
|
|
- [ComfyExtension TypeScript Interface](../../src/types/comfy.ts)
|
|
|
|
## Need Help?
|
|
|
|
- Check the [Development Guide](./development.md) for common issues
|
|
- Review [Core Extensions](./core.md) for examples
|
|
- Visit the [ComfyUI Discord](https://discord.com/invite/comfyorg) for community support |