custom-nodes/help_page

[giscus[bot]]

custom-nodes/help_page

How to create rich documentation for your custom nodes

https://docs.comfy.org/custom-nodes/help_page

[geroldmeisinger]

sigh

The path for images has to be relative to the docs directory. Absolute paths or relative paths to repository don't work.

Example Structure

my-custom-node/
├── __init__.py
├── web/              # WEB_DIRECTORY
│   ├── js/
│   │   └── my-node.js
│   └── docs/
│       ├── MyNode.md           # Fallback documentation
│       └── MyNode/
│           ├── example.png
│           ├── en.md           # English version
│           └── zh.md           # Chinese version

=> ![My Example Image](MyNode/example.png)

The fallback renderer, when no explicit markdown file is defined, renders HTML (tables) directly from node's io.Schema information (description, inputs, outputs).

Tab characters in markdown tables are not supported.

The code for markdown rendering is located in ComfyUI-frontend-package and uses the npm package marked

ComfyUI_frontend/src/components/sidebar/tabs/nodeLibrary/NodeHelpPage.vue ->
ComfyUI_frontend/src/components/node/NodeHelpContent.vue ->
ComfyUI_frontend/src/stores/workspace/nodeHelpStore.ts ->
import { renderMarkdownToHtml } from '@/utils/markdownRendererUtil' ->
import { Renderer, marked } from 'marked'

[geroldmeisinger]

sigh

Comfy UI Languages, Translations, Internationalisation, Internationalization, i18n, Multilingual, Translate, Localisation, Localization, Locales, Translator

is documented in https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/CONTRIBUTING.md#internationalization
(ensuring that no-one will ever find out about it and contribute)

Language is set in Settings -> Comfy -> Language, not from browser locale. You don't have to reload.

supported locales as of 2026-01-01 are:

ar
en
es
fr
ja
ko
pt-BR
ru
tr
zh-TW
zh

• Main-language fallbacks are not supported (i.e. pt-BR will NOT choose pt), and will choose en instead.
• The node documentation is loaded in nodeHelpStore.ts.