Dokumentation des Markdown-Editors

Dieser Artikel enthält einige Informationen über den Contentful Markdown-Editor, die nicht sofort aus der Benutzeroberfläche ersichtlich und zu erwarten sind. Insbesondere werden die Tastenkombinationen, die Link-Organisation, die Medieneinbettung und das HTML-Rendering erläutert.

Verwenden von Tastenkombinationen

Die Zeit und der Aufwand für das Erlernen von Tastenkombinationen zahlen sich im Allgemeinen aus: Sie können Aufgaben schneller erledigen, da die Tastatur bequemer zu bedienen ist als eine Maus oder ein Trackpad.

Hier sind die vom Editor unterstützten Tastenkombinationen. Wenn Sie Windows verwenden, drücken Sie Strg anstelle von Cmd.

• Cmd+Z – Rückgängig machen

• Cmd+R – Wiederholen

• Cmd+B – Text fett formatieren

• Cmd+I – Text kursiv formatieren

• Tab – Text einrücken

• Shift+Tab – Einrücken aufheben

• Esc – Vollbildmodus beenden

Es gibt zwei Möglichkeiten, Links in Markdown zu erstellen. Die erste heißt Inline-Links:

Die URLs werden direkt im Text platziert. Dieser Ansatz funktioniert gut, wenn Sie nur zwei oder drei davon haben, ist aber nicht so gut für größere Mengen an Links, weil es chaotisch wird.

Eine alternative Möglichkeit besteht darin, eine Liste aller Links am Ende zu führen, sodass sie folgendermaßen aussehen:

Anstatt die gesamte URL inline zu platzieren, würden Sie nur ihre Nummer verwenden:

Der Grund, warum wir Ihnen das alles darlegen? Der Markdown-Editor kann die Links automatisch organisieren. Drücken Sie einfach auf die Schaltfläche Links organisieren:

Sobald Sie darauf klicken, werden alle Inline-Links durch Referenzen ersetzt und die URLs werden an das Ende des Dokuments verschoben.

Perspektive von Autor*innen

Contentful ermöglicht die Einbettung vieler Arten von externem Medien-Content, einschließlich, aber nicht beschränkt auf Bilder, Videos, Tweets und PDFs, in Markdown-formatierte Texte. Klicken Sie auf Externen Content einbetten, fügen Sie den Link zur externen Ressource ein, und der Editor erledigt den Rest. Obwohl Sie im Textbearbeitungsmodus nur den Codeausschnitt sehen, zeigt die Vorschau die Medienressource so an, wie sie aussehen soll.

Liste der unterstützten Dienste anzeigen.

Perspektive von Entwickler*innen

Wir verwenden Embedly, um externen Content anzuzeigen. Um Embedly-Karten auf Ihren Websites und in Ihren Apps anzuzeigen, sollten Sie die entsprechenden Bibliotheken von Embedly verwenden. Weitere Informationen finden Sie in der Dokumentation.

So gut die Markdown-Syntax auch ist, für einige Dinge reicht sie nicht aus. Zugegeben, das Formatieren von Tabellen in Markdown ist nicht gerade angenehm. Es ist auch nicht möglich, eine benutzerdefinierte Bildgröße in Markdown festzulegen.

HTML kann in diesen Fällen hilfreich sein. Sicherlich ist es nicht gerade hilfreich für Entwickler*innen, die den Content, den Sie für sie vorbereiten, verarbeiten müssen, aber es kann Editor*innen ein grundlegendes Verständnis dafür geben, wie der fertige Content aussehen wird.

Der Contentful Markdown-Editor unterstützt grundlegende HTML-Tags. Wir empfehlen Ihnen, den Content mit Markdown-Markup zu formatieren, aber manchmal ist es einfach schwierig, das Schreiben von Tags wie  <img src="../screenshot-3.png" width="400"/> zu vermeiden.