03 Markdown Basics - Gepardec/github-wiki-training GitHub Wiki

Markdown Cheat-Sheet: https://gist.github.com/csalmhof/bc67222fd55a2f95aa9053bb98c1b032

Was ist Markdown?

Markdown ist eine vereinfachte Auszeichnungssprache, die von John Gruber und Aaron Swartz entworfen und im Dezember 2004 mit Version 1.0.1 spezifiziert wurde. Ein Ziel von Markdown ist, dass schon die Ausgangsform ohne weitere Konvertierung leicht lesbar ist.

from: Wikipedia

Mittels Konvertierungssoftware wird der Markdown-Text in weiterer Folge in gültiges XHTML umgewandeld.

GitHub Flavored Markdown (GFM)

GitHub verwendet eine eigene Version der Markdown Syntax welche zusätzliche nützliche Features enthält wie bspw. HTML-Support oder Emojis.

GitHub erkennt Markdown-Files anhand der Endung .md und zeigt diese dann formatiert an.

GFM Markdown Syntax

Die grundlegenden Sachen zur Textformatierung wie Überschriften, Text fett oder kursiv sind sehr einfach umzusetzen.

Die wichtigsten Syntax-Elemente zur Formatierung sind im Markdown-Cheat-Sheet zu finden.

Beispiel:

*Kursiver Text*

**Fetter Text**

***Kursiver und fetter Text***

_auch kursiver Text_

__auch fetter Text__

___auch kursiver und fetter Text___

wird zu

Kursiver Text

Fetter Text

Kursiver und fetter Text

auch kursiver Text

auch fetter Text

auch kursiver und fetter Text