Markdown Tutorial

Markdown einfach erklärt

Was ist Markdown?

Markdown ist eine vom Menschen und Maschinen lesbare Sprache zur Formatierung und Gliederung von Texten. Die Sprache ist sehr einfach gehalten und kann somit sehr schnell erlernt werden.

Markdown-Editoren sind nützliche Helfer bei der Verwendung der Sprache.

Was kann mit Markdown gestaltet werden?

1. Überschriften

   • werden durch eine oder je nach Level mehrere Rauten (# ) realisiert
   • das Leerzeichen hinter der Raute ist essentiell
   • vor der Raute muss eine Leerzeile Stehen
   • mehre Rauten (##) ergeben h2, etc

2. Absätze

   • werden durch eine Leerzeile davor und dahinter erzeugt

3. Zeilenumbrüche

   • mit zwei Leerzeichen im Text erzeugt man einen Zeilenumbruch

4. Listen

   • Unsortierte Listen werden durch *, +, - eingeleitet
   • Sortierte Listen werden durch 1., 2., etc beschrieben
   • die Listen können verschachtelt werden

5. Hervorhebungen

   • **fett** fett
   • *kursiv* kursiv
   • ***fett und kursiv*** fett und kursiv

6. Zitate

   • werden wie im Emails durch ein Größerzeichen eingeleitet
   • > Beispielzitat

7. URLs

   • jsakh

8. Hugo Shortcodes Um Parameter aus der “config.json” oder “config.toml” in der Markdown-Datei einzufügen können sogenannte Shortcodes verwendet werden. Der Syntax sieht so aus: {{< param name >}} Wobei name durch den Namen des Schlüssels in der Params-Sektion ersetzt wird.

Markdown2HTML - Markdown in HTML konvertieren

Im folgenden Abschnitt erkläre ich wie man aus Markdown HTML macht. Dazu verwenden wir das neu entwickelte Hugoplus.