Docsify Beispielworkflow

Workflow Übersicht

Dieser Workflow verwendet n8n, um eine dynamische Dokumentation für n8n-Workflows zu generieren. Es werden verschiedene Knoten verwendet, um den Status des Workflows zu verwalten, HTML-Seiten zu generieren und Markdown-Dokumente zu speichern.

Knoten im Detail

1. CONFIG (Set)

• Typ: Set
• Zweck: Definiert die Konfiguration wie den Projektpfad, die Instanz-URL und HTML-Einstellungen für die Dokumentation.
• Parameter:
  • project_path: `./.n8n/test_docs` – Directory für die Speicherung der Dokumente.
  • instance_url: `={{$env[„N8N_PROTOCOL“]}}://{{$env[„N8N_HOST“]}}` – Dynamische Instanz-URL basierend auf Umgebungsvariablen.
  • HTML_headers und HTML_styles_editor: Definierte HTML-Stile und -Header für die Docsify-Dokumentation.

2. Convert to File

• Typ: Convert to File
• Zweck: Konvertiert Workflow-Daten in ein Text-Dokument.
• Parameter:
  • operation: `toText` – Die Operation, die durchgeführt wird.
  • sourceProperty: `workflowdata` – Der Datensatz, der konvertiert werden soll.

3. HasFile? (If)

• Typ: If
• Zweck: Überprüft, ob eine Datei existiert.
• Parameter:
  • conditions:
    • leftValue: `={{ Object.keys($json).length }}` – Prüft die Anzahl der Schlüssel im JSON.
    • operator: `gt` – Prüft, ob die Anzahl größer als 0 ist.

4. Extract from File

• Typ: Extract from File
• Zweck: Extrahiert den Inhalt aus einer Markdown-Datei.
• Parameter:
  • operation: `text` – Die Art der Extraktion.
  • destinationKey: `workflowdata` – Ziel für die extrahierten Daten.

5. Main Page (HTML)

• Typ: HTML
• Zweck: Generiert die Hauptseite für die Docsify-Dokumentation.
• Parameter:
  • html: Enthält den HTML-Code, der die Struktur und das Design der Dokumentation definiert.

6. Instance overview (HTML)

• Typ: HTML
• Zweck: Gibt eine Übersicht der Workflows in n8n zurück.
• Parameter:
  • html: Gibt eine formatierte Tabelle mit den Workflows, deren Status und weiteren Details zurück.

7. Sort-workflows (Sort)

• Typ: Sort
• Zweck: Sortiert die Workflows basierend auf dem aktualisierten Datum.
• Parameter:
  • sortFieldsUi:
    • order: `descending` – Absteigende Sortierung nach aktualisiertem Datum.
    • fieldName: `updatedAt` – Das Feld, nach dem sortiert wird.

8. doc action (Switch)

• Typ: Switch
• Zweck: Bestimmt die Aktion basierend auf der Benutzeranfrage, wie z.B. `view`, `edit`, oder `save`.
• Parameter:
  • rules: Definiert die verschiedenen möglichen Aktionen, die ausgeführt werden können.

9. Load Doc File (Read/Write File)

• Typ: Read/Write File
• Zweck: Lädt die Markdown-Datei, die der Benutzer anzeigt oder bearbeitet.
• Parameter:
  • fileSelector: `={{ $(‚CONFIG‘).first().json.project_path }}/{{ $json.params.file }}` – Bestimmt, welche Datei geladen wird.

10. Respond with HTML

• Typ: Respond to Webhook
• Zweck: Gibt die HTML-Antwort an den Benutzer zurück.
• Parameter:
  • respondWith: `text` – Gibt den Antworttyp an.
  • responseBody: `={{ $json.html }}` – Der zu sendende HTML-Inhalt.

Ergebnis

Mit diesem Workflow können Benutzer eine benutzerfreundliche Dokumentation für n8n-Workflows erstellen und bearbeiten. Die Möglichkeiten zur Betrachtung, Bearbeitung und Erstellung neuer Dokumente ermöglichen es, den Workflow flexibel zu steuern und anzupassen.

Download Link: Hier herunterladen