Markdown-Formatierung

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Ziele

• Konsistenz: ein Parsing-Schritt, mehrere Renderer.
• Sicheres Chunking: Text vor dem Rendern aufteilen, damit Inline-Formatierung nie über Chunks hinweg bricht.
• Passend zum Kanal: dieselbe IR ohne erneutes Markdown-Parsing auf Slack mrkdwn, Telegram HTML und Signal-Stilbereiche abbilden.

​

Pipeline

1. Markdown parsen -> IR
   • IR besteht aus Klartext plus Stil-Spans (fett/kursiv/durchgestrichen/Code/Spoiler) und Link-Spans.
   • Offsets sind UTF-16-Codeeinheiten, damit Signal-Stilbereiche mit seiner API übereinstimmen.
   • Tabellen werden nur geparst, wenn ein Kanal Tabellenkonvertierung aktiviert.
2. IR in Chunks aufteilen (Format zuerst)
   • Das Chunking erfolgt auf dem IR-Text vor dem Rendern.
   • Inline-Formatierung wird nicht über Chunks hinweg aufgeteilt; Spans werden pro Chunk zugeschnitten.
3. Pro Kanal rendern
   • Slack: mrkdwn-Tokens (fett/kursiv/durchgestrichen/Code), Links als <url|label>.
   • Telegram: HTML-Tags (<b>, <i>, <s>, <code>, <pre><code>, <a href>).
   • Signal: Klartext + text-style-Bereiche; Links werden zu label (url), wenn sich das Label unterscheidet.

​

IR-Beispiel

Hello **world** - see [docs](https://docs.openclaw.ai).

{
  "text": "Hello world - see docs.",
  "styles": [{ "start": 6, "end": 11, "style": "bold" }],
  "links": [{ "start": 19, "end": 23, "href": "https://docs.openclaw.ai" }]
}

​

Wo es verwendet wird

• Ausgehende Adapter für Slack, Telegram und Signal rendern aus der IR.
• Andere Kanäle (WhatsApp, iMessage, Microsoft Teams, Discord) verwenden weiterhin Klartext oder ihre eigenen Formatierungsregeln, wobei die Markdown-Tabellenkonvertierung vor dem Chunking angewendet wird, wenn sie aktiviert ist.

​

Tabellenbehandlung

• code: Tabellen als Codeblöcke rendern (Standard für die meisten Kanäle).
• bullets: jede Zeile in Aufzählungspunkte konvertieren (Standard für Matrix, Signal und WhatsApp).
• off: Tabellen-Parsing und -Konvertierung deaktivieren; der rohe Tabellentext wird unverändert weitergegeben.

channels:
  discord:
    markdown:
      tables: code
    accounts:
      work:
        markdown:
          tables: off

​

Chunking-Regeln

• Chunk-Limits stammen aus Kanaladaptern bzw. der Konfiguration und werden auf den IR-Text angewendet.
• Code-Fences bleiben als einzelner Block mit abschließendem Zeilenumbruch erhalten, damit Kanäle sie korrekt rendern.
• Listenpräfixe und Blockquote-Präfixe sind Teil des IR-Texts, sodass das Chunking nicht mitten im Präfix aufteilt.
• Inline-Stile (fett/kursiv/durchgestrichen/Inline-Code/Spoiler) werden nie über Chunks hinweg aufgeteilt; der Renderer öffnet Stile innerhalb jedes Chunks erneut.

​

Link-Richtlinie

• Slack: [label](url) -> <url|label>; bloße URLs bleiben unverändert. Autolink ist während des Parsings deaktiviert, um doppelte Verlinkung zu vermeiden.
• Telegram: [label](url) -> <a href="url">label</a> (HTML-Parse-Modus).
• Signal: [label](url) -> label (url), außer das Label entspricht der URL.

​

Spoiler

​

So fügen Sie einen Kanal-Formatter hinzu oder aktualisieren ihn

1. Einmal parsen: verwenden Sie den gemeinsamen markdownToIR(...)-Helper mit kanalgeeigneten Optionen (Autolink, Überschriftenstil, Blockquote-Präfix).
2. Rendern: implementieren Sie einen Renderer mit renderMarkdownWithMarkers(...) und einer Stilmarker-Zuordnung (oder Signal-Stilbereichen).
3. Chunking: rufen Sie chunkMarkdownIR(...) vor dem Rendern auf; rendern Sie jeden Chunk.
4. Adapter verdrahten: aktualisieren Sie den ausgehenden Kanaladapter, damit er den neuen Chunker und Renderer verwendet.
5. Testen: fügen Sie Formatierungstests hinzu oder aktualisieren Sie sie sowie einen Test für ausgehende Zustellung, wenn der Kanal Chunking verwendet.

​

Häufige Fallstricke

• Slack-Token in spitzen Klammern (<@U123>, <#C123>, <https://...>) müssen erhalten bleiben; escapen Sie rohes HTML sicher.
• Telegram HTML erfordert das Escaping von Text außerhalb von Tags, um beschädigtes Markup zu vermeiden.
• Signal-Stilbereiche hängen von UTF-16-Offsets ab; verwenden Sie keine Codepoint-Offsets.
• Bewahren Sie abschließende Zeilenumbrüche für eingezäunte Codeblöcke, damit Abschlussmarkierungen in ihrer eigenen Zeile landen.

​

Verwandt