Skip to main content

Documentación de nodos con Markdown

Los nodos personalizados pueden incluir documentación en Markdown completa que se mostrará en la interfaz en lugar de la descripción genérica del nodo. Esto ofrece a los usuarios información detallada sobre la funcionalidad, los parámetros y los ejemplos de uso de tu nodo. Si ya has añadido tooltips para cada parámetro en la definición del nodo, puedes acceder directamente a esta información básica desde el panel de documentación del nodo. No es necesario añadir más documentación del nodo, y puedes consultar la implementación relacionada de ContextWindowsManualNode

Configuración

Para añadir documentación para tus nodos personalizados o documentación con soporte para varios idiomas:
  1. Crea una carpeta docs dentro de tu WEB_DIRECTORY
  2. Añade archivos Markdown con el nombre de tus nodos (los nombres de tus nodos son las claves del diccionario NODE_CLASS_MAPPINGS que se usa para registrarlos):
    • WEB_DIRECTORY/docs/NodeName.md: documentación predeterminada
    • WEB_DIRECTORY/docs/NodeName/en.md: documentación en inglés
    • WEB_DIRECTORY/docs/NodeName/zh.md: documentación en chino
    • Añade otros idiomas según sea necesario (por ejemplo, fr.md, de.md, etc.)
El sistema cargará automáticamente la documentación adecuada según el idioma del usuario, y recurrirá a NodeName.md como respaldo si no hay una versión localizada disponible.

Funciones de Markdown compatibles

  • Sintaxis Markdown estándar (encabezados, listas, bloques de código, etc.)
  • Imágenes con sintaxis Markdown: ![texto alternativo](image.png)
  • Elementos multimedia HTML con atributos específicos:
    • Etiquetas <video> y <source>
    • Atributos permitidos: controls, autoplay, loop, muted, preload, poster

Estructura de ejemplo

Archivo Markdown de ejemplo