Grundlegende Syntax von Markdown

Überschriften

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

Betonungen

Markdown kennt 3 Arten von Betonungen und eine beliebige Kombination daraus:

1. kursiv (entspricht <i>)
2. fett (entspricht <b>)
3. durchgestrichen (entspricht <s>)

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.

# keine Überschrift

Absätze

Absätze werden durch eine Leerzeile erstellt (entspricht Raum zwischen 2 <p>, oder 2 mal <br/> innerhalb eines <p>). Aus Kompatibilitätsgründen sollte ein Absatz nicht mit einem Leerzeichen oder einem Tabulator eingerückt sein.

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Zeilenumbrüche

Zeilenumbrüche (entspricht <br/>) werden erzeugt, indem man am Ende einer Zeile zwei oder mehr Leerzeichen setzt. Da man die Leerzeichen nicht so leicht sehen kann, werden diese im Beispiel mit dem HTML-Entity für ein Kit-Leerzeichen dargestellt. In der Praxis funktioniert das allerdings nur mit echten Leerzeichen. Beachten Sie außerdem, das bestimmte Texteditoren die Leerzeichen am Ende jeder Zeile beim Speichern automatisch entfernen. Diese Funktion sollte für Markdown abgeschaltet werden, da sonst die gewollten Zeilenumbrüche beim Speichern verschwinden.

Lorem ipsum dolor sit amet, consectetuer sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
At vero eos et accusam et justo duo dolores et ea rebum.

Links

Verlinkungen (entspricht <a>) gibt es auch in Markdown. 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.

Hier wird einem geholfen.

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. Sortierte und unsortierte Listen können auch miteinander vermischt werden.

Sortiert

Die Listenpunkte der sortierten Liste (entspricht <ol>) beginnen stets mit einer Zahl, gefolgt von einem Punkt und dann ein Leerzeichen.

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

Unsortiert

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

• Zucker: 45 g
• Mehl
  • 405 Mehl: 100 g
  • Dinkelmehl: 300g
• 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, oder sogar ganze Sätze hervorheben. Nützlich, um technische Angaben besonders hervorzuheben, wie z.B. einzugebende Befehle, oder spezielle Schlüsselwörter. Der hervorzuhebende Text wird dabei mit einem Backtick (`) umschlossen.

Mit std::uint8_t werden vorzeichenfreie 8 Bit Ganzzahlen dargestellt.

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 (entspricht <img>) funktionieren im Prinzip genauso, wie Links. Der einzige Unterschied ist, dass Sie ein ! (Ausrufezeichen) vor der eckigen Klammer schreiben.

Zitieren

Dieses Verfahren erlaubt das Zitieren, das Darstellen von Verschachtelungen, oder das Anzeigen eines Gesprächsverlaufs. Bei einem Zitat schreibt man am Beginn einer Zeile ein > (größer-als). In HTML haben wir dafür das <blockquote>-Element.

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 in HTML 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 erstellen

Bevor man Sie benutzt, muss man erst einmal wissen, wie man sie erstellt. Wir erstellen nun 3 Referenzen:

Diese schreibt man am besten am Ende des Dokuments, aber im Prinzip spielt es keine Rolle wo, da die Liste selbst unsichtbar bleibt.

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:

Ihr Computer spinnt? Melden Sie sich bei HuSvEDVF. Der Laptop teilt sich in zwei Hälften? Auch da gehen Sie zu HuSvEDVF. Zum herumexperimentieren haben wir NoExist. Wollen Sie mehr über den mitteldeutschen Raum erfahren, dann gehen Sie auf 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 (entspricht <table>) dargestellt werden. Dabei wird der senkrechte Strich (|), für die Definition von Spalten verwendet. Als Beispiel wird die Tabelle 1 leicht abgewandelt aus dem Artikel Der CashFlow 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:

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