Diese Seite erklärt welche Features Markdown hat und welche zusätzlichen Features auf dieser Seite unterstützt werden.
Für weitere Dokumentation schaue dir das an:Markdown SyntaxMarkdown Extra Syntax
Markdown Erklärung
Markdown soll so leicht zu lesen und schreiben sein wie möglich
Lesbarkeit ist allerdings am wichtigsten. Ein Markdown formatiertes Dokument sollte veröffentlichbar sein so wie es ist, als unformatierter text, ohne dabei auszusehen, als wäre es mit Formatvorgaben erstellt worden. Markdown's Syntax ist beeinflusst von verschiedenen Text-Zu-Html Filtern: Setext, atx, Textile, reStructuredText, GrutaText und EtText. Allerdings ist der größte Einfluss dass unformatierte Textformat einer E-Mail.
Zu diesem Zweck besteht die Syntax von Markdown ausschließlich aus Zeichen, die sorgfältig ausgewählt wurden, damit sie nach dem aussehen, was sie bedeuten. Z. B. sehen Sternchen um ein Wort herum tatsächlich aus wie * Hervorhebung *. Markdown-Listen sehen aus wie, nun ja, Listen. Selbst Blockzitate sehen aus wie zitierte Textpassagen, vorausgesetzt, man hat schonmal E-Mail verwendet.
Cheat Sheet
Header1
===
Header2
---
# Header1 #
## Header2 #
### Header3 #
#### Header4
##### Header5
###### Header6
---
List:
- cool
- not cool
- ok
1. do *that*
1. do _this_
1. just __chill__
---
Quote:
> Here is a quote
>> and a quote in a quote
>
> back to the quote
> **you** are ok
---
Code:
echo "fine";
~~~c
private static void main(string[] args)
{
// do something
}
~~~
Here is some text `with code in it`.
---
Table, Picture, Link:
| Favicon | Address |
|----------:|:-------------------------:|
| ![Logo][] | <https://bentigorlich.de> |
[logo]: https://bentigorlich.de/favicon.ico "Logo"
Header1
Header2
Header1
Header2
Header3
Header4
Header5
Header6
List:
- cool
- not cool
- ok
- do that
- do this
- just chill
Quote:
Here is a quote
and a quote in a quote
back to the quote
you are ok
Code:
echo "fine";
private static void main(string[] args)
{
// do something
}
Here is some text with code in it
.
Table, Picture, Link:
Favicon | Address |
---|---|
https://bentigorlich.de |
Paragraphen und Zeilenumbrüche
Ein Paragraf ist einfach nur eine oder mehrere aufeinanderfolgende Zeilen Text, getrennt durch eine oder mehrere leere Zeilen. (eine leere Zeile ist jede Zeile die leer aussieht, eine Zeile die nur Leerzeichen order Tabs enthält, zählt als leer)Normale Paragrafen sollten nicht mit Leerzeichen oder Tabs eingerückt sein
Die Annahme der 'eine oder mehrere aufeinanderfolgende Zeilen Text'-Regel ist, dass Markdown 'harte Zeilenumbrüche' unterstützt
Dies unterscheidet sich signifikant von den meisten anderen Text-Zu-Html Konvertierern (einschließlich der 'Konvertier Zeilenumbrüche'-Option von Movable Type), welche jedes Zeilenumbruch-Zeichen innerhalb eines Paragrafen in ein <br /> (Zeilenumbruch) Tag umwandelt.
Überschriften
Markdown unterstützt zwei Stile von Überschriften: Setext und atx.
Überschriften im Setext Stil sind 'unterstrichen' mit Gleichheitszeichen (Level 1 Überschriften) und Bindestrichen (Level 2 Überschriften).
Das ist Level 1
=============
Das ist Level 2
-------------
Das ist Level 1
Das ist Level 2
Irgendeine Anzahl unterstreichender Gleichheitszeichen oder Bindestriche funktionieren.
Überschriften im Atx-Stil nutzen hashtags am Zeilenanfang, dessen Anzahl das Level der Überschrift definieren.
Optional kann man Überschriften im Atx-Stil auch schließen. Das ist rein Optisch und du kannst es nutzen wenn du der Meinung bist dass es besser aussieht. Die Schließenden hashtags müssen nicht einmal die selbe Anzahl haben wie die öffnenden. zum Beispiel:
# Das ist Level 1 #
## Das ist Level 2 ##############
###### Das ist Level 6 #
Das ist Level 1
Das ist Level 2
Das ist Level 6
Zitate
Markdown nutzt '>' Zeichen für Zitate, im E-Mail Stil. Wenn du bereits weißt wie man in E-Mails zitiert, weißt du schon wie man in Markdown zitiert. Es sieht am besten aus wenn du ein '>' Zeichen vor jede Zeile packst:
> Das ist ein Zitat mit zwei Paragrafen. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.
Das ist ein Zitat mit zwei Paragrafen. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.
Markdown erlaubt dir faul zu sein und nur vor die erste Zeile ein '>' Zeichen zu setzen:
> Das ist ein Zitat mit zwei Paragrafen. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
Das ist ein Zitat mit zwei Paragrafen. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.
Zitate können verschachtelt sein, indem man mehrere '>' Zeichen an den Zeilenanfang setzt:
> Das ist das erste Level
>
> > Das ist ein verschachteltes Zitat
>
> Zurück im ersten Level.
Das ist das erste Level
Das ist ein verschachteltes Zitat
Zurück im ersten Level.
Zitate können andere Markdown Elemente, auch Überschriften, Listen und Code Blöcke, enthalten
> ## Das ist eine Überschrift.
>
> 1. Das erste Listenelement
> 2. Das ist das zweite Listenelement
>
> Beispiel code:
>
> return shell_exec("echo $input | $markdown_script");
Das ist eine Überschrift.
- Das erste Listenelement
- Das ist das zweite Listenelement
Beispiel code:
return shell_exec("echo $input | $markdown_script");
Listen
Markdown unterstützt sortierte (numerierte) und unsortierte Listen.
Unsortierte Listen nutzen Sterne, Plus und Minuszeichen als Listenmarker:
* Rot
* Grün
* Blau
---
+ Rot
+ Grün
+ Blau
---
- Rot
- Grün
- Blau
- Rot
- Grün
- Blau
- Rot
- Grün
- Blau
- Rot
- Grün
- Blau
Sortierte Listen nutzen Zahlen gefolgt von Punkten:
1. Vogel
2. McHale
3. Gemeinde
---
1. Vogel
1. McHale
1. Gemeinde
---
3. Vogel
1. McHale
8. Gemeinde
- Vogel
- McHale
- Gemeinde
- Vogel
- McHale
- Gemeinde
- Vogel
- McHale
- Gemeinde
Code Blöcke
Formatierte Code Blöcke werden genutzt wenn man über Programmierung oder Quellcode schreibt. Um einen Code Block in Markdown zu erstellen musst du einfach jede Zeile des Blocks um mindestens 4 Leerzeichen oder einen Tab einrücken.Ein Einrückungslevel wird von jeder Zeile entfernt. Zum Beispiel:
tell application "Foo"
beep
end tell
tell application "Foo"
beep
end tell
Innerhalb eines Code Blocks werden '&', '<' und '>' Zeichen automatisch in HTML Elemente umgewandelt. Das macht es sehr einfach HTML Beispiele mit markdown zu veranschaulichen, einfach einfügen und einrücken. Markdown übernimmt dann das encodieren.
Reguläre Markdown Syntax wird nicht innerhalb von Code Blöcken verarbeitet. '*' Beispielsweise sind einfach '*' innerhalb eines Codeblocks und werden nicht zu Listenelementen. Das heißt es ist einfach mit Markdown über Markdown Syntax zu schreiben.
Horizontale Linien
Du kannst eine horizontale Linie erzeugen indem du 3 oder mehr '*', '-' oder '_' Zeichen in einer Zeile ohne andere Zeichen schreibst. Wenn du magst kannst du auch Leerzeichen einfügen.
* * *
***
*****
- - -
___
---------------------------------------
Links
Markdown unterstützt 3 Arten von Links: inline, reference und direct. Bei inline und reference ist der Linktext innerhalb von eckigen Klammern. Um einen inline-Link zu erstellen folgt den eckigen Klammern direkt ein Link in normalen Klammern. Wenn du dem Link noch einen Titel geben willst steht dieser in Anführungszeichen innerhalb derselben Klammern.Wenn du einfach nur eine klickbare URL in deinem Text haben möchtest, pack die URL zwischen '<' und '>' und Markdown macht daraus einen link.
Das ist [ein Beispiel](https://example.com/ "Titel") inline link.
[Dieser Link](https://example.net/) hat kein Titel Attribut.
Das ist ein Beispiel inline link.
Dieser Link hat kein Titel Attribut.
Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link.
Das ist [ein Beispiel][id] reference-style link.
[BentiGorlich][]
<https://bentigorlich.de/>
[id]: https://example.com/ "Optionaler Titel"
[BentiGorlich]: https://bentigorlich.de/
Das ist ein Beispiel reference-style link.
BentiGorlich
https://bentigorlich.de/
Hervorhebung
Markdown behandelt '*' und '_' Zeichen als Hervorhebungsindikatoren. Text innerhalb eines '*' oder '_' wird kursiv dargestellt; innerhalb von 2 '*' oder '_' fett.
*ein Stern*
_ein Unterstrich_
**zwei Sterne**
__zwei Unterstriche__
un**fucking**glaublich
ein Stern
ein Unterstrich
zwei Sterne
zwei Unterstriche
unfuckingglaublich
Code
Um Code innerhalb eines normalen Paragrafen anzuzeigen pack es zwischen '`' Zeichen.
Nutze die `printf()` Methode.
``Hier ist ein einzelnes zeichen (`).``
Nutze die printf()
Methode.
Hier ist ein einzelnes zeichen (`).
Bilder
Zugegeben, es ist relativ schwierig eine 'natürliche' syntax zum einfügen von Bildern zu entwickeln. Markdown nutzt eine Syntax zum einfügen von Bildern die die Syntax für Links erweitert. Hier gibt es 2 varianten: inline und reference.
![Alt text](https://bentigorlich.de/favicon.ico "Optional title")
![Logo][]
[logo]: https://bentigorlich.de/favicon.ico "Logo"
Tabellen
Die erste Zeile enthält den Spalten Header; die zweite Zeile die verpflichtende separator Linie zwischen Header und Inhalt. Jede Folgende Zeile ist eine Zeile in der Tabelle. Spalten sind immer durch das '|' Zeichen getrennt. Du kannst für jede Spalte die Orientierung festlegen, indem du das ':' Zeichen zu der Separator Linie hinzufügst: links meint Linksorientiert, rechts meint rechtsorientiert und auf beiden Seiten meint Zentriert
| Methodenname | Beschreibung |
| :-------------: | -----------------------------: |
| `help()` | Zeigt das Hilfefenster |
| `destroy()` | **Zerstört den Computer!** |
Methodenname | Beschreibung |
---|---|
help() |
Zeigt das Hilfefenster |
destroy() |
Zerstört den Computer! |
Fußnoten
Fußnoten funktionieren größtenteils wie Links im reference Stil. Eine Fußnote besteht aus 2 Komponenten: ein Marker im Text, der zu einer hochgestellten Zahl wird und eine Fußnoten Definition, die in eine Liste am Ende des Dokuments eingefügt wird.
Fußnoten Definitionen können überall im Dokument auftauchen, werden aber immer in der selben Reihenfolge wie im Text am Ende aufgelistet. Merke, dass du nicht zwei mal zu selben Fußnote verlinken kannst. Wenn du das versuchst, wird die zweite Fußnote nicht verlinkt.
Jede Fußnote muss einen eindeutigen Namen haben. Dieser Name wird verwendet um die Fußnoten Referenz zu der Fußnoten Definition zu verlinken, hat aber keinen Effekt auf die Nummerierung.
Checkboxen
- [ ] Box
- [x] ausgefüllte Box
- Box
- ausgefüllte Box