Node Documentation with Markdown
Custom nodes can include rich markdown documentation that will be displayed in the UI instead of the generic node description. This provides users with detailed information about your node’s functionality, parameters, and usage examples. If you have already added tooltips for each parameter in the node definition, this basic information can be directly accessed via the node documentation panel. No additional node documentation needs to be added, and you can refer to the related implementation of ContextWindowsManualNodeSetup
To add documentation for your nodes or multi-language support documentation:- Create a
docs
folder inside yourWEB_DIRECTORY
- Add markdown files named after your nodes (the names of your nodes are the dictionary keys in the
NODE_CLASS_MAPPINGS
dictionary used to register the nodes):WEB_DIRECTORY/docs/NodeName.md
- Default documentationWEB_DIRECTORY/docs/NodeName/en.md
- English documentationWEB_DIRECTORY/docs/NodeName/zh.md
- Chinese documentation- Add other locales as needed (e.g.,
fr.md
,de.md
, etc.)
NodeName.md
if a localized version is not available.
Supported Markdown Features
- Standard markdown syntax (headings, lists, code blocks, etc.)
- Images using markdown syntax:

- HTML media elements with specific attributes:
<video>
and<source>
tags- Allowed attributes:
controls
,autoplay
,loop
,muted
,preload
,poster