Grundlegende Syntax von Markdown

Überschriften

Überschriften beginnen mit # bis 6 Stück und müssen nicht geschlossen werden.
Nach dem # sollte aus Kompatibilitätsgründen ein Leerzeichen folgen.

Betonungen

Aus Kompatibilitätsgründen ist es besser * für kursiv, ** für fett und *** für beides kombiniert zu verwenden.

kursiv
fett
durchgestrichen
kursiv, fett und durchgestrichen

Maskierungszeichen

Mit einem Backslash (\) kann man dafür sorgen, dass nachfolgende Zeichen nicht als Funktionszeichen interpretiert werden.

Absätze

Absätze werden durch eine Leerzeile erstellt. Aus Kompatibilitätsgründen sollte ein Absatz nicht mit einem Leerzeichen oder einem Tabulator eingerückt sein.

Zeilenumbrüche

Zeilenumbrüche werden erzeugt indem man am Ende einer Zeile zwei oder mehr Leerzeichen setzt.

Links

Der Titel, welcher sich zwischen den Anführungszeichen befindet, ist optional. Er zeigt sich, wenn man mit dem Mauszeiger auf den Link zeigt. Beachten Sie, dass Links immer im aktuellen Fenster geöffnet werden und es momentan nicht eindeutig definiert ist, dieses Verhalten zu ändern.

Listen

Markdown unterstützt sowohl sortierte als auch unsortierte Listen. In sortierten und unsortierten Listen können Einträge mit Tabs und Leerzeichen eingerückt werden um einen Unterpunkt zu erstellen.

1. erster Eintrag <− 1. erster Eintrag
2. zweiter Eintrag <− 2. zweiter Eintrag
3. dritter Eintrag <− 3. dritter Eintrag
   1. erster Unterpunkt <−    1. erster Unterpunkt
   2. zweiter Unterpunkt <−    2. zweiter Unterpunkt
4. vierter Eintrag <− 4. vierter Eintrag

Unsortierte Listen werden mit (+), (*) oder (-) am Zeilenanfang erstellt. Aus Kompatibilitätsgründen sollte man für die komplette Liste immer dasselbe Zeichen verwenden.

• Zucker: 45 g <− + Zucker: 45 g
• Mehl <− + Mehl
  • 405 Mehl: 100 g <−   + 405 Mehl: 100 g
  • Dinkelmehl: 300 g <−   + Dinkelmehl: 300 g
• Milch: 500 ml <− + Milch: 500 ml

Präformierter Text

Mit dem präformierten Text können entweder Texte im Textfluss (entspricht <code>), oder Textblöcke (entspricht <pre>) dargestellt werden. Diese werden dabei stets als Blockschrift dargestellt und beinhalten auch alle nicht sichtbaren Zeichen, wie z.B. mehrere Leerzeichen in Folge, Einrückungen und Umbrüche. Dies eignet sich besonders zur Darstellung von unformatierten Texten und Quellcode.

Texte im Textfluss

Im fließenden Text kann man einzelne Wörter wie `HTML` → HTML beschreiben, aber auch ganze Sätze, wie `HTML und CSS zum Erstellen von Webseiten.` → HTML und CSS zum Erstellen von Webseiten.. Wie man sieht, wird der Text mit einem Backtick umschlossen. Sehr hilfreich, wenn man z.B. bei einer Erklärung die Schlüsselwörter aus einer Programmiersprache benennen will.

Textblöcke

Textblöcke funktionieren fast genauso, stattdessen wird aber der gesamte Textblock mit jeweils 3 Backticks umschlossen.

Wie man sieht, kann man bei den einleitenden 3 Backticks auch noch die Sprache nennen. In diesem Fall haben wir C++ genannt und der Quelltext wurde auch entsprechend farblich hervorgehoben. Generell gilt also für einen Textblock:

1. Mit 3 Backticks einen Textblock einleiten.
2. Optional die Sprache nennen, hier war es CPP.
3. In der nächsten Zeile den Textblock einfügen.
4. In einer neuen Zeile wieder 3 Backticks, um den Textblock abzuschließen.

Bilder

Bilder funktionieren im Prinzip genauso, wie Links. Der einzige Unterschied ist, dass Sie ein ! (Ausrufezeichen) vor der eckigen Klammer schreiben.

Zitieren

Das Blockquote-Element dient zum Zitieren, Darstellen von Verschachtelungen, oder auch zum Zeigen eines Gesprächsverlaufs. Bei einem Zitat schreibt man am Beginn einer Zeile ein > (größer-als).

E: Klug ist jener, der Schweres einfach sagt.

Um zu verschachteln, verwendet man mehr, als nur ein > (größer-als).

E: Klug ist jener, der Schweres einfach sagt.

T: Tolles Zitat, Herr Einstein.

Es sei noch anzumerken, dass das Blockquote-Element standardmäßig keine Formatierung hat. Richtig wäre ein senkrechter Strich auf der linken Seite des Zitats. Im Falle des Beispiels, habe ich diesen senkrechten Strich mal hinzugefügt.

Referenzieren

Zu einer der Nützlichsten, jedoch leider auch meistens unbekannten Funktion gehört das Referenzieren. Diese funktionieren ähnlich wie eine Auflistung von Quellen, nur sehen Sie diese Liste dann nicht. Stattdessen können Sie nun überall im Dokument auf solch eine Quelle verweisen. Der Aufbau ist wieder ähnlich, wie das Verlinken oder Einfügen von Bildern, was auch Sinn macht, weil genau das wollen wir ja Referenzieren. Diesmal gibt es aber 2 Dinge zu erklären.

1. Referenzen auflisten:
   Bevor man Sie benutzt, muss man erst einmal wissen, wie man sie erstellt. Wir erstellen nun 3 Referenzen:
   [HuSvEDVF]: https://www.husvedvf.de "Hilfe & Service von EDV-Fachleuten"
[NoExist]: https://www.noexist.de "No Exist"
[limdr]: https://www.lebenimmdr.de "Leben im Mitteldeutschen Raum" Diese schreibt man am besten am Ende des Dokuments, aber im Prinzip spielt es keine Rolle, da die Liste selbst unsichtbar bleibt. Was auch auffällt, man kann hinter dem Link im doppelten Hochkomma noch einen Titeltext angeben (HTML-Titel-Attribut).
2. Referenzen benutzen:
   Da wir nun eine Liste von Referenzen haben, können wir diese auch Nutzen. Der Clou dabei ist, das wir nur noch den Teil mit den eckigen Klammern schreiben müssen: [HuSvEDVF] [HuSvEDVF] [HuSvEDVF] [NoExist] [NoExist] [NoExist] [limdr] [limdr] [limdr] →
   HuSvEDVF HuSvEDVF HuSvEDVF
   NoExist NoExist NoExist
   limdr limdr limdr

   Der Name der Referenz ist dann also der Link-Text selbst. Dies funktioniert sogar mit Bildern, allerdings kommt das Ausrufezeichen dann nicht in die Referenzliste, sondern an die Stelle, wo man die Referenz benutzt ([NAME] -> ![NAME]).

Tabellen

In Markdown können auch Tabellen dargestellt werden. Dabei wird der senkrechte Strich (|), für die Definition von Spalten verwendet. Zuerst definiert man den Tabellenkopf:

Der Tabellenkopf wird mit einer Zeile voller Bindestriche (−) abgeschlossen. Mit dem Doppelpunkt (:) kann man die Bündigkeit des Textes in den Spalten bestimmen. Dabei gilt Folgendes:

• Linksbündig: Nur linke Seite, oder kein Doppelpunkt.
• Rechtsbündig: Doppelpunkt nur auf der rechten Seite.
• Zentriert: Doppelpunkt auf der linken und rechten Seite.

Im Beispiel haben wir also die 1. Spalte zentriert, die 2. Spalte linksbündig und die 3. Spalte rechtsbündig. Nun folgen die Datenzeilen der Tabelle:

Das ganze sieht dann zum Schluss in etwa so aus:

Wie man auch im Beispiel sieht, kann man die Inhalte der Zellen mit Leerzeichen auffüllen, damit die Tabelle in Klartextform lesbarer ist. Die Tabelle endet, sobald in der nächsten Zeile keine Tabellenzeile mehr erkannt wird.