comfyui_embedded_docs
[!NOTE]
This is only for core nodes. For embedded custom node documentation, please see https://docs.comfy.org/custom-nodes/help_page
Updating Documentation
Each core node should have a folder containing its node name, then a two letter locale.md, and potentially any assets along with it in the same folder.
See FluxProUltraImageNode as an example.
[!NOTE]
A fallback is simply docs/NodeName.md, but this is discouraged.
Previewing Changes Locally
To preview your documentation changes in ComfyUI:
[!TIP]
The editable installation allows you to see changes immediately after copying files, without reinstalling the package.
Publishing
The package is automatically published to PyPI when:
- You manually trigger the workflow (Actions → Publish to PyPI → Run workflow)
- You push changes to
pyproject.toml
on the main branch
- A pull request that modifies
pyproject.toml
is merged to main
The publishing workflow:
- Builds the package using
python -m build
- Publishes to PyPI using the configured PYPI_TOKEN secret
Linting
To ensure minimal consistency across nodes documentation, it is recommended to follow the Markdown linting principles. Some of the linting issues can be fixed automatically with the shell script below. Note this requires to install markdownlint-cli
.
npm install -g markdownlint-cli
bash fix_markdown.sh
bash fix_markdown.sh ClipLoader
powershell -ExecutionPolicy Bypass -File fix_markdown.ps1