メインコンテンツへスキップ

Markdown によるノードドキュメント

カスタムノードには豊富な Markdown ドキュメントを含めることができ、一般的なノード説明の代わりに UI に表示されます。これにより、ユーザーはノードの機能、パラメータ、使用例に関する詳細情報を入手できます。 ノード定義ですでに各パラメータのツールチップを追加している場合、この基本情報はノードドキュメントパネルから直接アクセスできます。 追加のノードドキュメントを追加する必要はなく、ContextWindowsManualNode の関連実装を参照できます。

設定

カスタムノードのドキュメント或多言語サポートドキュメントを追加するには:
  1. WEB_DIRECTORY 内に docs フォルダを作成します
  2. ノード名にちなんで命名された Markdown ファイルを追加します(ノード名は、ノードを登録するために使用される NODE_CLASS_MAPPINGS 辞書の辞書キーです):
    • WEB_DIRECTORY/docs/NodeName.md - デフォルトドキュメント
    • WEB_DIRECTORY/docs/NodeName/en.md - 英語ドキュメント
    • WEB_DIRECTORY/docs/NodeName/zh.md - 中国語ドキュメント
    • 必要に応じて他のロケールを追加します(例:fr.mdde.md など)
システムはユーザーのロケールに基づいて適切なドキュメントを自動的に読み込み、ローカライズされたバージョンが利用できない場合は NodeName.md にフォールバックします。

サポートされている Markdown 機能

  • 標準 Markdown 構文(見出し、リスト、コードブロックなど)
  • Markdown 構文を使用した画像:![代替テキスト](image.png)
  • 特定の属性を持つ HTML メディア要素:
    • <video> および <source> タグ
    • 許可される属性:controlsautoplayloopmutedpreloadposter

例:構造

例:Markdown ファイル