Help Page
How to create rich documentation for your custom nodes
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.
Setup
To add documentation for your nodes:
- Create a
docs
folder inside yourWEB_DIRECTORY
- Add markdown files named after your 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.)
The system will automatically load the appropriate documentation based on the user’s locale, falling back to 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