Markdown

Von Torsten Schrade

Hintergrundinformationen

  • Entwickelt von John Gruber und Aaron Swartz (2004): Website
  • “HTML is a publishing format; Markdown is a writing format” (John Gruber)
  • Ziel: größtmögliche Leesbarkeit und Flexibilität
  • Dateiendung gewöhnlicherweise .md oder .txt
  • Zahllose Offline & Online Editoren, die Markdown verarbeiten können
  • Zahllose Programmbibliotheken, die Markdown in eine Vielzahl an Zielformaten konvertieren können (HTML, PDF, RTF)
  • Sehr geeignet zur Erstellung von Dokumentationen oder Online-Texten, aber auch zum Verfassen komplexer Texte
  • Seit 2010 werden die Pressemitteilungen der dpa im Markdown-Format veröffentlicht (http://www.dpa-newslab.com/2010/04/22/dpa-notizbuch-markdown/)
  • Markdown ist unser Basis-Text- und Schreibformat im Studiengang
  • Es gibt unterschiedliche “Flavours” (https://github.com/jgm/CommonMark/wiki/Markdown-Flavors)
  • Wir verwenden heute das klassische Flavour; aber nicht alle Variationsmöglichkeiten davon werden wir verwenden

Markdown Referenz

Ziel Notation Erweiterung
H1 # H1 Standard
H2 ## H2 Standard
H3 ### H3 Standard
H4 #### H4 Standard
H5 ##### H5 Standard
H6 ###### H6 Standard
Absatz ↲ + Leerzeile Standard
Zeilenumbruch ⋅⋅↲ Standard
Horizontale Linie Standard
Kursiv _Kursiv_ Standard
Fett **Fett** Standard
Streichung ~~Streichung~~ Pandoc
Tiefstellung H~2~O Pandoc
Hochstellung 2^10 Pandoc
Abkürzung *[Abkürzung]: Erklärung GFM
Escapes Mit Backslash: ` * _ # + - . ! {} [] () \ ^ Standard
Link [Linktext](URL) Standard
Referenz Im Text: [Wort][ID]; am Dokumentende: [ID]: Link Standard
Fußnote Im Text: [^n]; am Dokumentende [^n]: Text Pandoc
Bild ![Alternativtext](Bildquelle “Bildbezeichnung”) Standard
Aufzählung + Listenpunkt Standard
Nummerierung 1. Listenpunkt Standard
Definitionsliste Term + ↲ + : ⋅⋅⋅⋅ + Text Pandoc
Zitat > Zitattext Standard
Codeblock ```Sprache Standard
Tabellen Spalten mit |, Kopfzeile mit — abtrennen Pandoc

Linktipps