Eine Einführung in Markdown

Abschlag

Markdown ist ein Text-zu-HTML-Konvertierungstool. Heute ist es das De-facto-Synonym für eine Klasse von leichten Markup-Beschreibungssprachen. Es verwendet eine Klartextformatierungssyntax. Die Idee hinter Markdown war es, das Schreiben von Webseiten und insbesondere Blog-Einträgen so einfach wie das Schreiben einer E-Mail zu machen. Im November 2017 ist das Ziel erreicht und Markdown sowie dessen Ableitungen Asciidoc, Asciidoctor und Asciidoctor-pdf sind weit verbreitet.

Markdown konzentriert sich nur auf reinen Text und verzichtet auf alle anderen Komplexitäten, wie sie in HTML zu finden sind. Es ist leicht zu erlernen, da einfach gehalten, daher auch schneller, da minimale Zeichen verwendet werden, was auch zu einer geringeren Fehlerwahrscheinlichkeit am Ende führt. Siehe Abbildung 1 für ein grundlegendes Dokument, das im Markdown-Editor Stackedit angezeigt wird. Auf der linken Seite sehen Sie den Quellcode und auf der rechten Seite die entsprechende HTML-Ausgabe. Sie werden vielleicht feststellen, dass die Schlagzeilen einfach mit einer Anzahl von # markiert sind, entsprechend der Hierarchieebene der Schlagzeile.

Textkonvertierung

Der Klartext kann mit den Befehlszeilentools wie Markdown oder Pandoc in XHTML (HTML) und viele andere Formate konvertiert werden. Grundsätzlich erstellen beide Tools nur HTML-Fragmente und schreiben die Ausgabe nach stdout. Pandoc bietet den Schalter „-o Dateiname“ an, um die HTML-Ausgabe in die angegebene Datei zu schreiben. Wie unten zu sehen ist, heißt die Ausgabedatei basic.html und enthält das HTML-Fragment - zwei Überschriften und einen Absatz.

$ pandoc -o basic.HTML-Grundlagen.md $ Katze Basic.html 
Anleitung zum Erstellen von Debian-Paketen
 
Vorwort
 Für eine Maschine verantwortlich zu sein bedeutet, sich sowohl um die Hardware als auch um die Softwarekomponenten zu kümmern. Wie man es im Alltag als Systemadministrator sieht, ist es viel besser, Software als Softwarepaket zu installieren und nicht als Haufen von Quelldateien. Dies reduziert die Kosten für die ordnungsgemäße Wartung des Systems. $ 

Um eigenständige HTML-Dokumente mit einem vollständigen HTML-Header zu erstellen, akzeptiert Pandoc den Schalter „-s“ wie folgt:

$ pandoc -o basic.html -s einfach.md $ Katze Basic.html           
Anleitung zum Erstellen von Debian-Paketen
 
Vorwort
 Für eine Maschine verantwortlich zu sein bedeutet, sich sowohl um die Hardware als auch um die Softwarekomponenten zu kümmern. Wie man es im Alltag als Systemadministrator sieht, ist es viel besser, Software als Softwarepaket zu installieren und nicht als Haufen von Quelldateien. Dies reduziert die Kosten für die ordnungsgemäße Wartung des Systems.   

Der Vorteil, den Inhalt von Ihrer visuellen Anzeige zu trennen, besteht darin, dass er das Aussehen Ihrer Website nicht durcheinander bringt. Version 1.0.1, das von John Gruber und Aaron Swartz entwickelt wurde, wurde im Dezember 2004 veröffentlicht und ist als kostenlose Software erhältlich (siehe Links am Ende dieses Artikels).

Textelemente

Schlagzeilen

Überschriften werden entsprechend der entsprechenden HTML-Ebene mit einer Anzahl von #'s wie folgt geschrieben:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

Für H1 und H2 werden zwei alternative Schreibweisen akzeptiert:

H1 == H2 -- 

Bitte beachten Sie, dass die Anzahl der Gleichheitszeichen oder Bindestriche mit der Anzahl der Zeichen der Überschrift übereinstimmen muss.

Betonung von Text

Um Text hervorzuheben, werden diese Elemente unterstützt:

• kursiv: einzelne Sternchen oder einzelne Unterstriche
  --
  *wichtig* und _auch wichtig_
  --
• fetter Text: doppelte Sternchen oder doppelte Unterstriche
  --
  **wichtig** und __auch wichtig__
  --
• durchgestrichener Text: Doppeltilden
  --
  ~~Text~~
  --

Listen

Markdown unterstützt ungeordnete und geordnete Listen. Geordnete Listen beginnen mit einem Sternchen, einem Plus- oder einem Minuszeichen. Geordnete Listen beginnen einfach mit einer Ziffer. Um Unterlisten zu erstellen, rücken Sie das Listenelement um zwei Leerzeichen (Markdown, StackEdit) oder vier Leerzeichen (Pandoc) ein, wie unten gezeigt:

1. Früchte * Apfel * Banane 2. Getränke + Wasser + Milch 

Bilder

Am einfachsten ist es, den Inline-Stil wie folgt zu verwenden:

![Das Debian-Logo](debian-logo.png „Debian-Logo“) 

Dies zeigt das referenzierte Bild an. Sobald Sie den Mauszeiger über das Bild bewegen, sehen Sie den entsprechenden Beschreibungstext.

Code- und Syntax-Highlighting

Es gibt zwei Varianten - Inline-Code und Codeblöcke. Inline-Code ist in drei Backticks wie "'print ("Hello, world!”)“'. Codeblöcke beginnen und enden ebenfalls mit drei Backticks, jedoch in separaten Zeilen wie folgt:

"print ("Hallo Welt!")"

Markdown unterstützt keine Syntaxhervorhebung, aber Dialekte wie Markdown Here tun es.

Tabellen

Markdown unterstützt keine Tabellen, aber Erweiterungen wie GFM und Markdown Here tun es.

Block Zitate

Blockquotes beginnen einfach mit einem „>“-Zeichen. Es wird ganz praktisch, Text zu zitieren.

> "Oh! Es ist absurd, eine feste Regel zu haben, was man > lesen sollte und was nicht. Mehr als die Hälfte der modernen Kultur hängt > davon ab, was man nicht lesen sollte." > > Die Bedeutung von Ernsthaftigkeit. (Oscar Wilde) 

Links

Links verweisen auf andere Dokumente oder auf Abschnitte im aktuellen. Der Schreibstil ähnelt Bildern und besteht aus der Linkbeschreibung in eckigen Klammern und der URL in regulären Klammern.

[Ich bin ein Link im Inline-Stil](https://linuxhint.com) 

Außerdem können Sie einen alternativen Text hinzufügen:

[Ich bin ein Link im Inline-Stil mit zusätzlichem Text](https://linuxhint.com „LinuxHinweis“) 

Links können wie folgt referenziert werden:

[LinuxHint][1]… etwas Text… [1]: https://linuxhint.com 

Auf diese Weise können Sie ganz einfach Literaturlisten am Ende Ihres Dokuments erstellen, wie es in wissenschaftlichen Dokumenten üblich ist.

Fazit

Markdown ist ziemlich einfach und ein Muss für jeden, der Dokumentation macht und regelmäßig Inhalte veröffentlicht. Es ist eine große Freude, es zu benutzen.

Verweise

• StackEdit, https://stackedit.io/herausgeber
• Pandoc, http://pandoc.Organisation/
• Markdown, https://daringfireball.Netto/Projekte/Abschlag/
• Markdown-Spickzettel, https://github.com/adam-p/markdown-here/wiki/Markdown-Spickzettel