GitHub Markdown: Syntax-Überblick
Was ist Markdown? Überblick über die wichtigsten Syntaxelemente nach GitHub Flavored Markdown (GFM) – mit Tipps für GitHub Pages und Blog-Hosting.
Für die Nutzung von GitHub Pages sollte man die Markdown-Syntax kennen. Dieser Beitrag orientiert sich an den offiziellen GitHub-Dokumenten Mastering Markdown und Basic writing and formatting syntax.
1. Was ist Markdown?
Markdown ist eine leichte Auszeichnungssprache auf Basis von Plaintext. Sie wird verwendet, um formatierte Dokumente mit einfachem Text zu verfassen; im Vergleich zu anderen Auszeichnungssprachen ist ihre Syntax besonders leicht und übersichtlich. Da sich Markdown einfach in formatierte Dokumente wie HTML und Rich Text (RTF) umwandeln lässt, wird es häufig für mit Software ausgelieferte README-Dateien und für Online-Beiträge verwendet.
John Gruber entwickelte im Jahr 12004 des Holocene calendar die Sprache Markdown in enger Zusammenarbeit mit Aaron Swartz in Bezug auf die Syntax, mit dem Ziel, dass Menschen in einem gut les- und schreibbaren Plaintext-Format schreiben und diesen bei Bedarf in strukturell valides XHTML (oder HTML) konvertieren können.
2. Markdown-Syntax
Markdown hat keinen verbindlichen Standard; Details können je nach Einsatzort variieren. Die hier zusammengefasste Syntax folgt dem Standard von GitHub Flavored Markdown.
2.1. Zeilenumbruch und Absätze
Ein einmaliges Drücken der Eingabetaste erzeugt keinen Zeilenumbruch.
1
2
3
Erster Satz.
Zweiter Satz.
Dritter Satz.
Erster Satz. Zweiter Satz. Dritter Satz.
Ein Zeilenumbruch wird erzeugt, indem am Zeilenende mindestens zwei Leerzeichen eingefügt werden.
1
2
3
Erster Satz.
Zweiter Satz.
Dritter Satz.
Erster Satz.
Zweiter Satz.
Dritter Satz.
Absätze werden durch eine Leerzeile (zweimal Enter) getrennt.
1
2
3
Ein Absatz.
Ein anderer Absatz.
Ein Absatz.
Ein anderer Absatz.
2.2. Überschriften (Headers)
Es gibt insgesamt 6 Ebenen.
1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
Ein H1-Tag sollte grundsätzlich nur einmal pro Seite vorkommen; beim Schreiben von Posts oder Dokumenten wird es daher in der Regel nicht direkt verwendet.
2.3. Hervorhebungen
1
2
3
4
5
6
7
8
9
10
11
*Dieser Text ist kursiv*
_Dies ist ebenfalls kursiv_
**Dies ist fett**
__Das ist auch fett__
~~Das war ein Fehler~~
_Man **kann** sie kombinieren_
***Dieser gesamte Text ist wichtig***
Dieser Text ist kursiv
Dies ist ebenfalls kursiv
Dies ist fett
Das ist auch fett
Das war ein Fehler
Man kann sie kombinieren
Dieser gesamte Text ist wichtig
2.4. Blockzitate
> verwenden.
1
2
3
> Dies ist ein erstes Blockzitat.
>> Dies ist ein zweites Blockzitat.
>>> Dies ist ein drittes Blockzitat.
Dies ist ein erstes Blockzitat.
Dies ist ein zweites Blockzitat.
Dies ist ein drittes Blockzitat.
2.5. Codeblöcke
``` oder ~~~ verwenden.
1
2
3
4
5
```
git status
git add
git commit
```
1
2
3
git status
git add
git commit
Sie können auch eine Programmiersprache angeben, um Syntaxhervorhebung zu aktivieren.
1
2
3
4
5
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
1
2
3
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
2.6. Links
1
2
[GitHub Pages](https://pages.github.com/)
<https://pages.github.com/>
GitHub Pages
https://pages.github.com/
Sie können auch relative Links verwenden, die auf andere Dateien im Repository zeigen. Die Verwendung entspricht der im Terminal.
1
[README](../README.md)
2.7. Unsortierte Listen
- oder * verwenden.
1
2
3
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
2.8. Geordnete Listen
Zahlen verwenden.
1
2
3
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
2.9. Verschachtelte Listen
1
2
3
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
2.10. Aufgabenliste
Fügen Sie vor jedem Element [ ] hinzu, um eine Aufgabenliste zu erstellen. Verwenden Sie [x], um erledigte Aufgaben zu markieren.
1
2
3
- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request
- Finish my changes
- Push my commits to GitHub
- Open a pull request
2.11. Bilder einfügen
1
2
3
4
Methode: {(optional) Zusatzoptionen}
{: .align-center}
{: width="50%" height="50%"}
2.12. Tabellen erstellen
Mit | und - können Tabellen erstellt werden. Vor der Tabelle muss eine Leerzeile stehen, damit sie korrekt angezeigt wird. Es müssen mindestens drei - verwendet werden, damit die Tabelle erkannt wird.
1
2
3
4
5
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |