Gratis: Markdown 2 Oxid

 23. März 2017

Markdown ist eine alternative Möglichkeit, Texte ohne zusätzliche Editoren und ohne html-Tags zu formatieren. Hierfür müssen beim Verfassen eines Textes nur ein paar einfache Regeln eingehalten werden. Ein Leerzeichen bleibt ein Leerzeichen, zwei Leerzeichen ergeben einen Zeilenumbruch. Eine Leerzeile ergibt einen neuen Absatz.

Zusätzlich werden einfache Zeichen zur Formatierung verwendet, deren Aussehen grösstenteils auch ihrer Bedeutung entspricht:
Überschriften werden beispielsweise mit einer Linie aus = Zeichen unterstrichen, Listenpunkte mit einen - begonnen. Soll etwas betont werden, wird es von * umrahmt. Dadurch funktioniert Markdown sehr intuitiv und erfordert kaum Einarbeitungszeit.
Bereits im Grundzustand sind die Klartexte perfekt lesbar, da es keine Unterbrechungen durch html-Tags gibt.

Ein Beispiel:

Wie im folgenden Kästchen wird etwas mit Markdown formatiert:

Überschrift  
===========  
- Das ist *kursiv*.   
- Das hier ist **fett**.  
Am 'Ende' noch eine Linie.  
**************************  

Markdown wandelt die so formatierten Texte für die Ausgabe auf einer Website in das html-Format um. Diese Arbeit erledigt im OXID eShop das Modul Markdown2Oxid unauffällig im Hintergrund bei Artikelbeschreibungen und CMS-Seiten. Das obige Beispiel sieht auf der Website folgendermaßen aus:

Überschrift

  • Das ist kursiv .
  • Das hier ist fett.
    Am Ende noch eine Linie.

Beide Version des Textbeispiels sind bestens lesbar.

Schreiben mit Markdown macht Spaß!
Scheiben für das Web wird angenehmer und einfacher, da der Schreibfluss nicht unterbrochen werden muss. Formatiert wird intuitiv während der Eingabe, nicht dannach.

Shortcodes:

Das Modul stellt einige Shortcodes bereit, die das Einfügen von Bildern und Medien erleichtern.
Ein Shortcode ist eine kurze Zeichenfolge, die während des Verfassens eines Textes schnell eingegeben werden kann. Vor der Ausgabe auf der Website wird diese Zeichenfolge dann vom Modul durch etwas anderes ersetzt. Ein {img} im Text wird beispielsweise durch den Pfad zum Verzeichniss für eigene Bilder ersetzt.

Für welchen Anwendungsfall eignet sich Markdown?

Ganz einfach: Zum Schreiben von Texten.

Markdown ist nicht dazu geeignet, einen WYSIWYG-Editor wie den TinyMCE komplett zu ersetzen. Autoren, die Ihre Texte mit verschiedenen Farben oder mit unterschiedlichen Schriftgrössen/Arten formatieren oder häufig Tabellen und zahlreiche Bilder einfügen, sind mit WYSIWYG-Editoren besser bedient. All dies ist zwar auch mit Markdown möglich, aber es ist nicht der ideale Anwendungfall.

Zum Schreiben von sauber formatierten Texten, die sich auf das Wesentliche beschränken (nämlich den Inhalt), ist Markdown eine interessante Alternative.
Dieser Artikel wurde übrigens mit Markdown formatiert, wenn Ihnen die Formatierung gefällt, können Sie Markdown2Oxid gerne ausprobieren.
Für unsere Kunden ist das Modul kostenfrei erhältlich: Zum Modul.

Eine ausführliche Übersicht der Formatierungsmöglichkeiten finden Sie hier: Dokumentation Markdown.