Markdown

Was ist der Markdown-Editor?

Der Markdown-Editor ist eine von drei Editor-Optionen, die in Document360 verfügbar sind. Es verwendet einen Kurztext-Syntaxstil – genannt Markdown –, um Text zu formatieren, der dann auf der Knowledge Base-Website in HTML umgewandelt wird.

Markdown ist eine leichte Auszeichnungssprache, mit der Sie Inhalte mit Sonderzeichen formatieren können, ohne direkt HTML schreiben zu müssen. Zum Beispiel macht Tippen **text** den Text fett und## Heading erzeugt eine Überschrift auf zweiter Ebene.

Der Markdown-Editor verwendet ein Splitscreen-Layout:

• Linkes Panel — Wo man Markdown-Syntax tippt und anwendet. Unterstützte Syntax wie Überschriften kann beim Tippen direkt in diesem Panel gestylt erscheinen, was das erwartete Verhalten ist.
• Rechtes Panel — Eine Live-Vorschau, die genau zeigt, wie der Artikel nach der Veröffentlichung auf der Knowledge Base-Seite erscheinen wird.

Du kannst Scroll On aktivieren, damit beide Panels während des Schreibens gleichzeitig scrollen. Klicken Sie auf Scrollen, um das auszuschalten.

Wann sollte man den Markdown-Editor verwenden

Der Markdown-Editor funktioniert am besten, wenn:

• Ihre Artikel sind hauptsächlich textbasiert mit minimalen multimedialen Elementen.
• Dein Team kennt sich mit Markdown-Syntax oder HTML aus und bevorzugt tastaturbasierte Schreibmethoden.
• Du musst benutzerdefinierte HTML-Tags oder Inline-Code verwenden, den die WYSIWYG-Editoren nicht unterstützen.
• Du arbeitest an codelastigen Dokumentationen wie API-Referenzen oder Entwickleranleitungen.

Wenn Ihre Artikel viele Bilder, Videos, Tabellen oder reichhaltige Formatierungen enthalten, könnte der Advanced WYSIWYG-Editor besser geeignet sein. → Editoren in Document360 vergleichen

Markdown-Grundlagen

Markdown verwendet einfache Zeichen, um Text zu formatieren. Hier ist eine kurze Referenz zur am häufigsten verwendeten Syntax:

Für die vollständige Markdown-Syntax-Referenz siehe → Basic Markdown-Syntax

Die Markdown-Werkzeugleiste

Die Markdown-Toolbar bietet schnellen Zugriff auf Formatierungsoptionen, ohne die Syntax manuell eingeben zu müssen. Wichtige Werkzeugleistenoptionen umfassen:

Konvertierung eines Markdown-Artikels in den Advanced WYSIWYG-Editor

Wenn Sie einen Markdown-Artikel in den Advanced WYSIWYG-Editor verschieben möchten – um auf reichhaltigere Inhaltsblöcke, Eddy AI und weitere Formatierungsoptionen zuzugreifen – können Sie ihn auf Artikelebene konvertieren.

Wie man konvertiert

1. Öffnen Sie den Artikel im Markdown-Editor.
2. Klicken Sie auf das Mehr- (•••)-Symbol oben rechts im Editor.
3. Wählen Sie weitere Artikeloptionen. Das Einstellungsfeld für Artikel erscheint.
4. Navigiere zum Editor-Reiter .
5. Wählen Sie den erweiterten WYSIWYG-Editor.
6. Wähle das Kästchen "Bist du sicher, dass du weitermachen willst?", um zu bestätigen.
7. Klicken Sie auf Speichern.

Der Artikel wird in den Advanced WYSIWYG-Editor umgewandelt und öffnet sich sofort im neuen Editor.

Was nach der Umwandlung zu erwarten ist

• Alle Textinhalte, Überschriften, Listen und grundlegende Formatierungen werden übernommen.
• Einige Markdown-spezifische Syntaxen, die im Advanced WYSIWYG-Editor nicht unterstützt werden – wie Markdown-Tabellen – müssen nach der Konvertierung mit den eingebauten Werkzeugen des Editors überprüft und neu erstellt werden.
• Du kannst den erweiterten WYSIWYG-Editor als Standard für alle neuen Artikel über Settings > Knowledge Base Portal > General > Editor festlegen. Dies wirkt sich nicht auf bestehende Markdown-Artikel aus.

Best Practices

• Nutze die Toolbar , wenn du neu bei Markdown bist – sie fügt automatisch die Syntax ein, sodass du keine Befehle auswendig lernen musst.
• Schreiben Sie die Syntax sorgfältig – kleine Fehler wie ein fehlendes Leerzeichen oder ein zusätzliches Zeichen verhindern, dass die Formatierung korrekt wiedergegeben wird.
• Nutzen Sie häufig das Live-Vorschaupanel , um vor der Veröffentlichung zu prüfen, wie der Inhalt aussehen wird, insbesondere bei komplexen Elementen wie Tabellen und Codeblöcken.
• Vermeiden Sie es, Markdown und HTML unnötig zu mischen – obwohl HTML unterstützt wird, kann eine übermäßige Nutzung zu Inkonsistenzen im Rendering führen.
• Erwägen Sie, in den Advanced WYSIWYG-Editor umzusteigen , wenn Ihr Artikel komplexer wird und Inhaltsblöcke wie Tabs, Akkordeons, Aufrufe oder interaktive Elemente benötigt.

FAQ