Markdown-Spickzettel - eine Kurzreferenz

veröffentlicht am 09.01.2016 mit 909 Worten - Lesezeit: 5 Minute(n) in * PROGRAMME * SOFTWARE *

Markdown ist eine einfach zu erlernende und auch zu merkende Auszeichnungssprache. Mit ihr können Texte formatiert werden, die dann einerseits auch für den Menschen als Quelltext (also direkt im Editor betrachtet) halbwegs “verdaulich” aussehen, andererseits leicht in andere Auszeichnungssprachen - für das Internet im Wesentlichen html - umgewandelt werden können.

Ich habe mir hier für meinen persönlichen Gebrauch die in diesem Blog verwendeten Formatierungen zusammengestellt. Vielleicht hilft’s ja dem einen oder anderen.

Grundsätzliches

Verwendet wird Markdown in vielen Websystemen wie z. B. Blog-Software, um dem Schreiber das schnelle Erstellen von Texten zu ermöglichen, ohne ständig mit der Maus in einem sog. WYSIWYG-Editor herumklicken zu müssen.

Der grau hinterlegte Kasten zeigt dabei jeweils, wie das Beispiel im Editor geschrieben aussieht, der Kasten darunter zeigt dann das Ergebnis an, wie es nach Durchlaufen der jeweiligen Software im Browser darstellt wird.

Textbetonungen

Dies ist ein _kursiver Text_ mit __fetten Wörtern__, aber auch ___fett kursiven Abschnitten___.

Anstelle der Unterstriche _ können auch Sterne * verwendet werden:

Dies ist ein *kursiver Text* mit **fetten Wörtern**, aber auch ***fett kursiven Abschnitten***.

Textstrukturierung

Überschriften

Anm.: Zwischen einem Textabsatz und einer darauf folgenden Überschrift muß eine Leerzeile eingeschoben werden.

# Überschrift erster Ordnung (Seitentitel)
## Überschrift zweiter Ordnung (Kapitelüberschrift)
### Überschrift dritter Ordnung
#### Überschrift vierter Ordnung

Wie die jeweilige Überschrift dann konkret dargestellt wird, das hängt von den Formatierungsanweisungen des jeweiligen Templates der Webseite ab, hier werden z. B. die Überschriften erster und zweiter Ordnung mit horizontalen Linien hervorgehoben, die Überschrift erster Ordnung zusätzlich auch noch hellgrau hinterlegt.

Zeilenumbrüche und Absätze

Ein einfacher Zeilenumbruch     
erfolgt durch Einfügen von 2 oder mehr Leerzeichen am Zeilenende.

Ein neuer Absatz entsteht durch Einfügen einer Leerzeile.

Listen

Hinweis: vor und nach einer Liste muß i. d. Regel eine Leerzeile eingefügt werden.

Zunächst die ungeordnete Liste:

- ein Listenpunkt
- noch ein Listenpunkt
- und ein weiterer Listenpunkt

Anstelle der Bindestriche - können auch Sterne * verwendet werden. Wichtig ist das Leerzeichen zwischen dem Symbol und dem darauffolgenden Text des Listenpunktes.

Die geordnete Liste weist eine Zählung auf:

1. ein Listenpunkt
3. noch ein Listenpunkt
2. und ein weiterer Listenpunkt

Wie man sieht, spielt die Reihenfolge der Nummerierung keine Rolle. Somit kann man auch jederzeit Listenpunkte “dazwischen schieben” - oder auch gänzlich auf eine Zählung verzichten und allen Punkte einfach ein 1. voranstellen.

Verweise

Hyperlinks

Keine Internetseite ohne Links, also muß es auch Möglichkeiten dazu in Markdown geben:

Dies ist ein [Link auf diese Seite](http://privat.albicker.org/blog/2016-01-10-markdown-spickzettel-referenz.html).

Mediendaten einfügen bzw. anhängen

Ein Bild wird eingefügt durch diesen Verweis:
![Alternativtext](/Pfad/zum/Bild.jpg "Bildtitel")

Ein Bild wird eingefügt durch diesen Verweis:

Dabei wird der Alternativtext benutzt, wenn das Bild nicht angezeigt wird (der Benutzer z. B. die Anzeige von Bildern im Browser sperrt oder aber sich den Text vorlesen läßt), der Bildtitel wird in vielen Browsern angezeigt, wenn mit der Maus über das Bild gefahren wird.

Ein Dokument wird wie ein Link zu einer Webseite über einen [Verweistext](/Pfad/zum/Dokument.pdf) aufgerufen.

Text-Trenner: horizontale Linie

wird durch 3 oder mehr * oder - erzeugt, z. B. so:

*****

und das bewirkt dann eine einfache durchgezogene Linie auf der ganzen Seitenbreite:

Besondere Textarten

Zitate

werden mit einem vorangestellten > markiert. Sie können dabei ein- oder mehrzeilig sein, das > muß dabei nicht wiederholt werden.
Voraussetzung: es wird nur der Zeilenumbruch (mehrere Leerzeichen am Ende der Zeile, siehe oben) verwendet und nicht ein neuer Absatz begonnen (Leerzeile).

> Never change a running system.
Never run a changing system.
Change a never running system.   

Programmcode

Code kann ein- oder mehrzeilig sein: einzeilig oder nur einzelne Befehlswörter können bsp. im laufenden Text eingebunden sein:

dies ist ein `einzeiliger Programmcode` im laufenden Text

Der Programmcode wird dabei vom Apostroph “`” eingeschlossen.

Mehrzeiliger Programmcode wird meist verwendet, um ganze Programmblöcke zu dokumentieren:

    languageCode = "de-DE"
    title = "Seiten, die die Welt (nicht) braucht"
    relativeURLs = true
    uglyURLs = false
    theme = "privat"

Der ganze Programmzeilen-Block wird um einen Tab = 4 Leerzeichen eingerückt (innerhalb von Listen müssen das 8 Leerzeichen sein). Dargestellt wird das dann so:

languageCode = "de-DE"
title = "Seiten, die die Welt (nicht) braucht"
relativeURLs = true
uglyURLs = false
theme = "privat"

Anstatt den Block einzurücken, kann er auch oben und unten mit je einer Zeile aus drei Apostrophen ``` eingegrenzt werden.

Auch hier gilt - wie bei den Überschriften: Wie die jeweilige Textart dann konkret dargestellt wird, das hängt von den Formatierungsanweisungen des jeweiligen Templates der Webseite ab.

Nützliche Erweiterungen

Tabellen

sind in der ursprünglichen Markdown-Syntax offenbar nicht enthalten. Es gibt aber Erweiterungen, Hugo versteht z. B. auch den “Github-Flavor”, und danach sieht eine Tabelle so aus:

    | Links ausgerichtet | Mittig ausgerichtet | Rechts ausgerichtet |
    |:------------------ |:-------------------:| -------------------:|
    | Inhalt             | Inhalt              | Inhalt              |
    | Inhalt             | Inhalt              | Inhalt              |

und das wird dann so dargestellt:

weitere Artikel

• Hugo und die Krux mit dem Zeilenumbruch
• Hugo und PHP? (Teil 2)
• Ein Theme für Hugo erstellen - Tutorial Teil 1 - Das Rohgerüst und die Startseite
• Hugo - kleine Kurztipps
• Hugo und PHP?