Wie man Markdown verwendet
Erstellt am 02.05.2019 um 19:12Uhr. Zuletzt verändert am 18.06.2019 um 19:33Uhr.
Das Hauptziel von Markdown besteht darin, leicht geschrieben und gelesen werden zu können. Es verwendet eine Klartextformatierung und kann in HTML umgewandelt werden. Markdown wird für die Erstellung von Ließmich-Dateien auf beispielsweise GitHub oder für die Erstellung von E-Mails verwendet. Im Vergleich zu HTML ist Markdown viel einfacher zu lesen und zu schreiben. Auch unerfahrene Benutzer können Markdown verstehen und sind meist in der Lage es zu erlernen.
Inhaltsverzeichnis
Überschriften
Überschriften werden mit #-Symbolen definiert. Ein ‘#’ für H1, zwei für H2, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# H1
## H2
### H3
#### H4
##### H5
###### H6
Alternativ dazu kann man H1 und H2 Überschriften auch
folgendermaßen unterstreichen:
Alt-H1
======
Alt-H2
------
H1
H2
H3
H4
H5
H6
Zitate
Zitate werden mit >-Symbolen definiert.
1
2
3
4
> Zwei Dinge sind unendlich, das Universum und die menschliche
Dummheit, aber bei dem Universum bin ich mir noch nicht
ganz sicher.
> <cite>Albert Einstein</cite>
Zwei Dinge sind unendlich, das Universum und die menschliche Dummheit, aber bei dem Universum bin ich mir noch nicht ganz sicher. Albert Einstein
Schriftauszeichnungen
Verwende zum Beginn und zum Ende des fett darzustellenden Textes je zwei Asterisks (*) oder Unterstriche (_).
1
2
**fetter Text mit Asterisks**
__fetter Text mit Unterstrichen__
Fetter Text mit Asterisks
Fetter Text mit Unterstrichen
Verwende zum Beginn und zum Ende des kursiv darzustellenden Textes je einen Asterisk (*) oder Unterstrich (_).
1
2
*kursiver Text mit Asterisk*
_kursiver Text mit Unterstrich_
kursiver Text mit Asterisk
kursiver Text mit Unterstrich
Verwende zum Beginn und zum Ende des durchgestrichen darzustellenden Textes je zwei Tilden (~).
1
~~durchgestrichener Text mit Tilden~~
durchgestrichener Text mit Tilden
Man kann fetten, kursiven oder durchgestrichenen Text natürlich auch innerhalb eines Satzes erzeugen.
Trennlinien
Trennlinien teilen Seiten in logische Abschnitte auf. Man kann sie mit drei Bindestrichen erzeugen.
1
---
Listen
Um eine ungeordnete Liste zu erstellen, verwendet man Bindestriche, Asterisks oder Pluszeichen
1
2
3
4
5
6
- Punkt
* Punkt
- Unterpunkt
- Unterpunkt
+ Punkt
- Punkt
- Punkt
- Punkt
- Unterpunkt
- Unterpunkt
- Punkt
- Punkt
Um eine geordnete Liste zu erstellen, nummeriert man die Punkte.
1
2
3
1. Punkt
2. Punkt
3. Punkt
- Punkt
- Punkt
- Punkt
Links
Um einfache, anklickbare Links zu erzeugen, schreibt man Links in spitze Klammern.
1
<https://www.jonas-schoenbach.dev>
https://www.jonas-schoenbach.dev
Wenn der Linktext vom eigentlichen Link abweichen soll, so wird dieser in eckige Klammern geschrieben und der tatsächliche Link direkt dahinter in runden Klammern.
1
[Jonas Schönbach](https://www.jonas-schoenbach.dev)
Wenn ein Link nun mehrfach benötigt wird, könnte man ihn jedes Mal neu einfügen. Wenn er sich dann allerdings ändert, muss er logischerweise an jeder Stelle angepasst werden. Dafür gibt es eine bessere Lösung. Man kann für den Link einen “Wörterbucheintrag” erstellen. Man weißt einem Schlüssel einen Wert - also den Link - zu. In eckigen Klammern steht der Schlüssel danach folgt ein Doppelpunkt, ein Leerzeihen und der Link. Auf den Link zugreifen kann man, indem man den Linktext in eckige Klammern schreibt, gefolgt vom Schlüssel der ebenfalls in eckigen Klammern steht.
1
2
[1]: https://www.jonas-schoenbach.dev
[Jonas Schönbach][1]
Man kann auch andere Orte innerhalb der Seite verlinken.
1
2
3
4
5
6
7
8
9
- [Zitate](#zitate)
- [Schriftauszeichnungen](#schriftauszeichnungen)
- [Trennlinien](#trennlinien)
- [Listen](#listen)
- [Links](#links)
- [Bilder](#bilder)
- [Code](#code)
- [Tabellen](#tabellen)
- [Weiterführende Websites](#weiterfhrende-websites)
Sobald eine Überschrift erstellt wurde, wird dadurch implizit auch eine ID angelegt. Dabei werden die Leerzeichen der Überschriften durch Bindestriche und alle Großbuchstaben durch Kleinbuchstaben ersetzt.
Bilder
Bilder werden mit einem Ausrufezeichen, gefolgt vom Alternativtext in eckigen Klammern eingeleitet. Darauf folgt der Link, gemeinsam mit dem Titel in runden Klammern.
1
Es ist natürlich wieder möglich eine Variable für das Bild festzulegen.
1
2
[logo]: /assets/markdown/markdown.png "Markdown-Logo"
![Alternativtext][logo]
Natürlich ist es auch mit HTML möglich:
1
<img src="/assets/markdown/markdown.png" alt="Markdown-Logo" width="48">
Mit HTML ist es auch möglich, die Größe des Bildes festzulegen.
Code
Innerhalb eines Satzes können mit zwei rückwarts geneigten Hochkommata einzelne Teile des Satzes als Code gekennzeichnet werden.
Codeblöcke haben aktuell eine maximallänge von 65 Zeichen, damit sie im Druck auch gut aussehen.
1
Das ist ein Beispielsatz, der ``Code`` enthält.
Das ist ein Beispielsatz, der Code enthält.
Mit drei rückwärts geneigten Hochkommata können Code-Blöcke definiert werden.
1
2
3
4
5
6
7
8
9
10
11
12
13
```c#
using System;
namespace HelloWorld
{
class Hello
{
static void Main()
{
Console.WriteLine("Hello World!");
}
}
}
```
1
2
3
4
5
6
7
8
9
10
11
12
using System;
namespace HelloWorld
{
class Hello
{
static void Main()
{
Console.WriteLine("Hello World!");
}
}
}
Optional kann nach den rückwärts geneigten Hochkommata noch die Sprache angegeben werden. Das sogt dann für die entsprechende Syntaxhervorhebung.
Tabellen
Tabellen werden folgendermaßen erstellt:
1
2
3
4
5
| | Spalte 1 | Spalte 2 |
|----------:|:--------:|-----------|
| Zeile 1 | 1;1 | 2;1 |
| Zeile 2 | 1;2 | 2;2 |
| Zeile 3 | 1;3 | 2;3 |
Hierbei stellt die erste Zeile die Kopfzeile dar. Danach folgt die Formatierungszeile. Sie besteht aus aus Bindestrichen. Doppelpunkte entscheiden darüber, ob die jeweilige Spalte Linksbündig (ohne Doppelpunkte), Zentriert (Doppelpunkt am Anfang und am Ende) oder Rechtbündig (Doppelpunkt rechts) dargestellt wird.
| Spalte 1 | Spalte 2 | |
|---|---|---|
| Zeile 1 | 1;1 | 2;1 |
| Zeil. 2 | 1;2 | 2;2 |
| Z. 3 | 1;3 | 2;3 |
Derartige Tabellen lassen sich einem einem Werkzeug (Tables Generator) erstellen .