Drücken Sie „Enter“, um den Inhalte zu überspringen

Markdown

Es gibt eine ganze Reihe von Sprachen, um Texte auszuzeichnen. Die aus dem Internet bekannte Hypertext Markup Language (HTML) oder das seinerzeit von Microsoft entwickelte Rich Text Format (RTF) sind typische Vertreter dieses Genres. Insbesondere in den Universitäten beliebt ist zudem noch das Textsatzsystem LaTeX, das vielleicht der mächtigste Vertreter in dieser Reihe ist, aber auch der komplizierteste. All diesen Auszeichnungssprachen ist gemein, dass für die Anzeige und Lesbarkeit ein spezieller Betrachter (Internet Browser, Textverarbeitung, PDF Viewer) benötigt werden, um neben den ganzen Auszeichnungen den eigentlichen Text noch erkennen zu können, bzw. eine Vorstellung von der späteren Ausgabe zu bekommen.

Und genau an dieser Stelle setzt Markdown an und räumt mit diesem Dilemma auf. Denn Ziel der Markdown Sprache ist es, dass schon der Ausgangstext mit seinen Auszeichnungselementen ohne zusätzliche Hilfsmittel oder besondere Konvertierungen für Menschen lesbar ist. Markdown stellt daher auch zunächst keine besonderen Anforderungen an entsprechende Bearbeitungsprogramme. Ein einfacher Texteditor genügt, um Markdown Texte zu lesen oder zu verfassen.

John Gruber, einer der beiden Erfinder von Markdown, sagte damals dazu:

Markdown is intended to be as easy-to-read and easy-to-write as is feasible.„.

Und er hielt sein Wort. Der Sprachumfang von Markdown in seiner grundlegenden Form lässt sich auf wenige wesentliche Sprachelemente beschränken:

  • Normaler Text
  • kursiv, fett, sowie fett-kursiv
  • Absätze
  • Aufzählungen und Nummerierungen
  • Überschriften
  • Zitate
  • Code Blöcke
  • Verweise (inkl. Bildverweise)

Darüber hinaus gibt es inzwischen über Zusatzprogramme diverse Erweiterungen, um weitere Elemente, wie z.B. Tabellen, in Markdown Syntax ausdrücken zu können.

Textformatierungen

Zur Auszeichnung von Textformatierungen verwendet Markdown wahlweise das * oder wahlweise das _ Symbol. Der auszuzeichnende Text wird dabei von diesen Symbolen ‚eingerahmt‘. Auf diese Art und Weise lassen sich *kursive*, **fett-gedruckte** oder ***fett und kursiv gedruckte*** Wörter oder Textabschnitte formatieren.

Absätze und Zeilenumbrüche

Jeder ohne Leerzeilen zusammenhängender Text wird in Markdown Syntax als Absatz betrachtet. Die Zeilenlänge passt sich dabei dem jeweiligen Zielformat an. Zeilenumbrüche erfolgen in der Regel völlig automatisch am Zeilenende.

Dennoch lassen sich Zeilenumbrüche auch erzwingen. So bewirken zwei oder mehr Leerzeichen am Ende einer Zeile einen erzwungenen Zeilenumbruch, denn ein einfaches Return am Ende einer Zeile dient lediglich der Lesbarkeit des Originaltextes und wird vom Markdown Interpreter ignoriert.

Zu beachten ist zudem, dass gewöhnliche Absätze nie mit Leerzeichen oder Tabulatoren eingerückt werden dürfen, da sie andernfalls eine andere Bedeutung bekommen, welche später noch beschrieben wird.

Aufzählungen und Nummerierungen

Auch Listen lassen sich mit Markdown auf eine elegante und eingängige Weise darstellen. Markdown unterscheidet hier zwischen Aufzählungen (ungeordneten Listen) und Nummerierungen (geordneten Listen). Aufzählungen sind einfache Stichwortsammlungen mit Punkt-Symbolen vor den einzelnen Aufzählungspunkten. Als Auszeichnung dient hier wieder das *Symbol. Wahlweise dürfen hier auch +oder - Symbole verwendet werden.

* Erster Aufzählungspunkt
* Zweiter Aufzählungspunkt
    - Ein mit Leerzeichen oder Tabulator eingerückter Unterpunkt
* Dritter Aufzählungspunkt

Analog gilt diese Syntax auch für Nummerierungen. Als Auszeichnung werden hier Zahlen mit darauf nachfolgendem Punkt 1.) verwendet. Für Markdown spielt es bei Nummerierungen keine Rolle, mit welcher Zahl die Nummerierung beginnt, noch welche Reihenfolge gewählt wird. So können beispielsweise alle Punkte mit 1. nummeriert werden. Die korrekte Nummerierung übernimmt später der Markdown Interpreter. So kann die Reihenfolge der Punkte im Bearbeitungsverlauf (unmerkbar) verändert werden und die korrekte Nummerierung bleibt trotzdem erhalten.

1. Ein Listeneintrag
2. Noch ein Listeneintrag
1. Ein weiterer Listeneintrag. Die vermeintlich falsche Nummerierung wird später vom *Markdown Interpreter* korrigiert

Selbstverständlich dürfen innerhalb der Listeneinträge auch andere Markdown-Elemente (z.B. Textformatierungen, Code-Blöcke, u.ä.) enthalten sein.

Überschriften

In einem ordentlich strukturierten Text dürfen selbstverständlich Überschriften nicht fehlen. Mit Markdown lassen sich Überschriften in sechs verschiedenen Ebenen darstellen. Die Ebenentiefe wird dabei mit der entsprechenden Anzahl von #Symbolen vor der jeweiligen Überschrift ausgezeichnet.

# Überschrift erster Ebene
## Überschrift zweiter Ebene
### Überschrift dritter Ebene
...
###### Überschrift sechster Ebene

Zitate

Für die Auszeichnung von Zitaten wird in Markdown das >Symbol verwendet. Die Syntax ist altbekannt, denn auf diese Art und Weise werden seit je her auch in Emails Zitate ausgezeichnet. So gilt für das eingangs in diesem Text genannte Zitat in Markdown-Syntax:

> "Markdown is intended to be as easy-to-read and easy-to-write as is feasible.".
>
> John Gruber

Und auch hier gilt, dass Zitate ebenfalls wieder weitere Markdown-Elemente enthalten dürfen.

Code Blöcke

Unter dem Begriff Code Blöcke werden Textabschnitte verstanden, die neutral und ohne weitere Formatierungen dargestellt werden. Typischerweise werden diese Code Blöcke zur Auszeichnung von Quellcode Zeilen oder Formeln verwendet.

Auch wenn die ursprüngliche Markdown-Syntax mit Einrückungen von mindestens 4 Leerzeichen oder einem Tabulator weiterhin gültig ist, so hat sich inzwischen die Angabe mit drei oder mehr Backticks (`) etabliert.

Mit dieser Syntax lassen sich mit Markdown sowohl ```Inline-Quelltexte```, wie auch ganze Absätze mit Quellcodes darstellen.

```
10 PRINT "HALLO"
20 GOTO 10
```

Verweise

Markdown unterstützt zwei Arten von Verweisen: Inline-Verweise und Referenzen. Verweise sind dabei mit den bekannten Links aus Webseiten vergleichbar und verhalten sind ähnlich. Inline-Verweise sind Verweise, die auf andere Dokumente, oder Webseiten zeigen und unmittelbar in den Textfluss integriert werden. Der darzustellende Text wird dabei mit eckigen Klammern ([]) ausgezeichnet. Daran schließt sich unmittelbar die Zieladresse (Url) in runden Klammern (()) an.

[idesis GmbH](https://www.idesis.de)

Referenzen hingegen werden an einer beliebigen Stelle im Text definiert und stehen als Verweise überall im Text zur Verfügung. So kann beispielsweise am Ende des Textes eine Liste mit Referenzen angefügt werden. Referenz-Definitionen sind in der Ergebnisdarstellung des Textes unsichtbar und werden nicht im Textfluss dargestellt. Die Definition von Referenzen erfolgt über eine in eckigen Klammern ausgezeichnete Beschreibung, gefolgt von einem : und der Zieladresse:

[Originalbschreibung]: https://bit.ly/1hhJLEK

Der Zugriff auf diese Referenzen, respektive die Darstellung im Textfluss, erfolgt durch eckige Klammern ([]) in denen auf die Referenz-Definition (hier: ‚Originalbschreibung‚) verwiesen wird, gefolgt von leeren eckigen Klammern ([]):

Für weitere Informationen zu *Referenzen*-Links verweisen wir auf die [Originalbeschreibung][] von John Gruber.

In der Ergebnisdarstellung erscheint das hier gezeigte Beispiel dann wie folgt, indem die zuvor genannte Referenz-Definition verwendet wird:

Für weitere Informationen zu Referenzen-Links verweisen wir auf die Originalbeschreibung von John Gruber.

Zusammenfassung

Mit Markdown lassen sich auf elegante und einfache Art und Weise strukturierte und formatierte Texte erstellen und lesen, ohne dass spezielle Programme dafür notwendig wären. Lediglich für die Umwandung des Textes nach Html oder PDF ist ein entsprechender Markdown-Interpreter erforderlich. Alle grundlegenden Elemente, die bei der Texterstellung erforderlich sind und üblicherweise benötigt werden, sind in Markdown vorhanden. Bekannte Internet-Plattformen, wie Github (github.com), setzen Markdown erfolgreich für die Dokumentation ein.

Share This

Share This

Share this post with your friends!