Kategorien
Content Management Systeme Editoren

Was ist eigentlich Markdown?

Wer Texte schreibt, benutzt oft Textverarbeitungsprogramme wie Microsoft Word oder LibreOffice. 

Wenn die Texte auf einer Website erscheinen sollen, hat man es meistens mit einem in ein Formularfeld eingebauten WYSIWYG Editor (What you see is what you get) zu tun. 

Wer eine E-Mail schreibt, muss sich ebenfalls für HTML oder „reinen“ Text entscheiden. Die meisten E-Mails werden mit einem WYSIWYG-Editor erstellt und als HTML und Textversion verschickt. 

Wenn man etwas im Web schreibt und im entsprechenden Feld kein WYSIWYG Editor zur Verfügung steht, darf man oft nur „Text“ schreiben. Das ist bei den meisten Social Networks wie Facebook, Instagram und Twitter der Fall. 

Manchmal sind in „reinen“ Textfeldern auch HTML-Tags erlaubt. Dort kann man dann den Text, so man es kann, im HTML Format eingeben. 

Wer jemals Probleme mit einer Textverarbeitungssoftware und WYSIWYG-Editoren hatte, der hebe bitte die Hand!
(Vermutlich werden, neben mir, viele gedanklich ihre Hand heben :).)

Um der Melange aus eher unübersichtlichem HTML-Text und mit zu vielen Features ausgerüsteten WYSIWYG Editoren zu entgehen, dachten sich John Gruber und Aaron Swartz die vereinfachte Auszeichnungsprache Markdown aus. 

Die Idee

Die Idee ist einfach. Ein grosses Ziel von Markdown ist, dass schon der mit den Markdown Auszeichnungen versehene Text, also die Ausgangsform, ohne weitere Konvertierung leicht lesbar ist. Wenn man in einem Textfeld etwas schreibt, kann man ja nur mit den vorhandenen Zeichen etwas hervorheben (auszeichnen).
Eine Liste würde vermutlich so aussehen:

- eins
- zwei
- drei

oder so

* eins
* zwei
* drei

Eine Überschrift in der erster Ordnung (H1) könnte man so schreiben …

# Überschrift erster Ordnung 

… eine Überschrift zweiter Ordnung (H2) vielleicht so:

## Überschrift zweiter Ordnung

Der grosse Vorteil einer solchen Schreibweise ist, ausser der bereits erkennbaren Struktur des Textes, der Schreibfluss. Man muss nicht mit der Maus oder dem Finger Text markieren und Icons klicken, sondern schreibt einfach ein Zeichen wie # oder * an den Anfang einer Zeile und alles was danach, bis zum nächsten Zeilenumbruch, geschrieben wird, ist dann eben eine Überschrift erster Ordnung oder eine Liste.

Welche Textauszeichnungen werden benötigt?

Vermutlich würde man mit der Möglichkeit Überschriften, Listen, Zitate, Code-Blöcke, Links, Bilder und vielleicht noch eine horizontale Linie, zu schreiben schon ziemlich weit kommen. Ein Beispiel

# Einladung zum Virtuellen Apéro

## Am 17.11.2020 um 19 Uhr

Heute ist wieder virtueller Apéro und es würde mich freuen, euch zu sehen. Wir haben folgende Themen:

* Websites
    * Performance
    * SEO
* Schule
    * CO2 Ampel
    * Mathe-Olympiade

Raum: https://meet.novatrend.ch/apero

Das schreibt sich mit Markdown Auszeichnungen tatsächlich leicht und wenn man es dann auf der Website sieht, sieht es so aus:


Einladung zum Virtuellen Apéro

Am 17.11.2020 um 19 Uhr

Heute ist wieder virtueller Apéro und es würde mich freuen, euch zu sehen. Wir haben folgende Themen

  • Websites
    • Performance
    • SEO
  • Schule
    • CO2 Ampel
    • Mathe-Olympiade

Raum: https://meet.novatrend.ch/apero


Aber wie geht das ganz praktisch und wer benutzt das überhaupt?

Die Urform von Markdown enthält die oben beschriebenen Auszeichnungen (und ein paar mehr) und bietet damit den „kleinsten gemeinsamen Auszeichnungs-Nenner“. Im „Ur-Markdown“ fehlen aber beispielsweise Auszeichnungen für Tabellen. Daher haben sich in den letzten Jahren viele „Dialekte“ vom Ur-Markdown gebildet, die neben dem Grundstock weitere Elemente erhalten

Wer benutzt Markdown?

Markdown positioniert sich ganz geschickt als Bindeglied zwischen WYSIWYG Ansätzen und reinem Text.

Beispiel Softwareentwicklung

Wer Software entwickelt, sollte diese dokumentieren oder zumindest dem Softwarepaket eine „Read me/Lies mich“ Datei mit den wichtigsten Stichworten mitgeben. Diese Dateien heissen readme.txt oder auch readme.md. Die Dateiendung .md steht für Markdown (md = markdown). Der Github Editor versteht Markdown und legt bei der Erstellung eines neuen Software-Projekts (Repository) standardmässig eine readme.md Datei an. Es ist eine kleine Hilfe für die Entwickler:in, zumindest eine kleine Einführung über das neue Projekt zu schreiben. Im Github-Editor lassen sich Markdown und HTML vermischen. Hier als Beispiel die Readme-Datei der deutschen Corona App.

https://github.com/corona-warn-app/cwa-app-ios/blob/release/1.8.x/README.md

Wenn du auf bearbeiten klickst, kannst du die Markdown Auszeichnungen sehen.

Content Management Systeme

Texteingabe in Content Management Systemen ist nach wie vor ein sehr grosses Thema.

WordPress

In WordPress gibt es mehrere Plugins, die es erlauben, die Texte in Markdown zu schreiben. Im Automattic Plugin Jetpack ist ein Markdown Block für den Gutenberg Editor enthalten, den ich auch hier benutze. Er arbeitet mit einem Eingabe – und einem Vorschaufenster.

Gutenberg Block – Markdown – Eingabe des Textes
Gutenberg Block – Markdown – Vorschau des Textes

Wer das Jetpack Plugin nicht mag, kann auch das „All-In-One Plugin WP Githuber MD benutzen.

Drupal

Drupal ist grundsätzlich sehr gut für solche Konzepte geeignet, da es standardmässig Eingabeformate verwaltet. Benutzerrollen können diesen Formate zugeordnet werden. Beispielsweise könnte man es so konfigurieren, dass Personen, die Kommentare schreiben, Markdown Auszeichnungen benutzen dürfen. Editoren aber zusätzlich noch alle HTML Befehle. In Drupal ist Markdown ein Eingabefilter innerhalb definierter Eingabeformate. Es lässt sich auch so konfigurieren, dass die Benutzer:innen das gewünschte Format selbst auswählen können.

https://www.drupal.org/project/markdown

Joomla

Die beliebte Joomla-Erweiterung JCE – Joomla Content Editor bietet die Möglichkeit Markdown Auszeichnungen zu verwenden.

https://www.joomlacontenteditor.net/support/documentation/editor/markdown

Stand-alone Programme

Für Microsoft PC, Apple Macs und Linux Geräte gibt es auch Textverarbeitungsprogramme die nur mit Markdown arbeiten. Hier eine unvollständige Liste zum stöbern:

Fazit

Es ist durchaus sinnvoll, sich über Textauszeichnung-Formate Gedanken zu machen auch wenn es am Ende kein Markdown wird. Gerade bei Websites, deren Inhalte von mehreren Personen gepflegt werden, kann ein durchgängiges Markdown Konzept oder zumindest die Auswahl (und Beschränkung) auf verschiedene mögliche Formate eine sehr grosse Hilfe für die Autoren darstellen.

Link


tl;dr: Es muss nicht immer ein „full-featured WYIWYG-Editor“ sein. Markdown bietet eine charmante Art auf den Punkt zu kommen.

Von hagengraf

Ich erstelle bequeme und benutzerfreundliche Orte in virtuellen und physischen Umgebungen.

Eine Antwort auf „Was ist eigentlich Markdown?“

Spannender Artikel – ich hätte mir gerne mehr Infos zur Geschichte und Entwicklung sowie den verschiedenen „Dialekten“ von Markdown gewünscht.

Kommentar verfassen