帮助页面
如何为自定义节点创建帮助文档
使用 Markdown 创建节点文档
自定义节点可以使用 Markdown 来创建富文本文档,这些文档信息将在 UI 中显示,取代常见的节点描述信息。可以为用户提供关于节点功能、参数和使用示例的详细信息。
设置
为你的节点添加节点文档:
- 在你的
WEB_DIRECTORY
中创建docs
文件夹 - 添加以节点命名的 Markdown 文件:
WEB_DIRECTORY/docs/NodeName.md
- 默认文档WEB_DIRECTORY/docs/NodeName/en.md
- 英文文档WEB_DIRECTORY/docs/NodeName/zh.md
- 中文文档- 根据需要添加其他语言版本(例如
fr.md
、de.md
等)
系统将根据用户的语言设置自动加载相应的文档,如果没有本地化版本,则回退到 NodeName.md
。
支持的 Markdown 功能
- 标准 Markdown 语法(标题、列表、代码块等)
- 使用 Markdown 语法的图片:

- 具有特定属性的 HTML 媒体元素:
<video>
和<source>
标签- 允许的属性:
controls
、autoplay
、loop
、muted
、preload
、poster