Markdown.md aktualisiert
This commit is contained in:
43
Markdown.md
43
Markdown.md
@@ -13,20 +13,17 @@ Einen Text in Markdown schreibt man mit jedem einfachen Editor.
|
||||
>Man kümmert sich **NICHT** um das Layout.
|
||||
|
||||
In diesem Bereich versuchen wir die wichtigsten Befehle zu beschreiben.
|
||||
|
||||
## Elemente in Markdown
|
||||
|
||||
Die folgenden Elemente kennt Markdown.
|
||||
|
||||
### Text
|
||||
## Text
|
||||
|
||||
Texte bestehen in der Regel auf Sätzen und Absätzen.
|
||||
|
||||
#### Sätze
|
||||
### Sätze
|
||||
|
||||
Jeder Satz wird in eine Zeile geschrieben.
|
||||
|
||||
#### Absätze
|
||||
### Absätze
|
||||
|
||||
Nach jedem Absatz wir eine Leerzeile eingefügt.
|
||||
Sie trennt die Absätze von einander.
|
||||
@@ -48,7 +45,7 @@ Diese sollte man auch vor und nach Überschriften machen.
|
||||
>Den Absatz beendet man mit einer Leerzeile.
|
||||
>Diese sollte man auch vor und nach Überschriften machen.
|
||||
|
||||
#### Zeilenumbruch innerhalb eines Absatzes
|
||||
### Zeilenumbruch innerhalb eines Absatzes
|
||||
|
||||
Man sollte eigentlich nur selten einen Zeilenumbruch innerhalb eines Absatzes machen.
|
||||
Es ist jedoch in Markdown auch möglich.
|
||||
@@ -69,7 +66,7 @@ Mustergasse 12
|
||||
99999 Musterstadt
|
||||
|
||||
|
||||
### Überschriften
|
||||
## Überschriften
|
||||
|
||||
Überschriften strukturieren ein Dokument.
|
||||
Sie bieten zusätzlich den Vorteil, dass sie automatisch mit einer ID versehen werden, sodass sie direkt angesprungen werden können.
|
||||
@@ -94,7 +91,7 @@ Da unsere Dokumente eher ein Kapitel darstellen, sollten wir mit H2-Überschrift
|
||||
```markdown
|
||||
Der letzte Absatz.
|
||||
|
||||
## die Überschrift
|
||||
#### die Überschrift
|
||||
|
||||
Der 1. Absatz nach der Überschrift.
|
||||
...
|
||||
@@ -104,12 +101,12 @@ Der 1. Absatz nach der Überschrift.
|
||||
|
||||
>Der letzte Absatz.
|
||||
>
|
||||
>## Die Überschrift
|
||||
>#### Die Überschrift
|
||||
>
|
||||
>Der 1. Absatz nach der Überschrift.
|
||||
>...
|
||||
|
||||
### Bilder
|
||||
## Bilder
|
||||
|
||||
Bilder können über einen speziellen Link als Inlinedokument eingebunden werden.
|
||||
|
||||
@@ -126,7 +123,7 @@ Es werden die Formate `.png`, `.svg` und `.jpg` unterstützt.
|
||||
|
||||
>
|
||||
|
||||
### Links
|
||||
## Links
|
||||
|
||||
Da Markdowndokumente meistens als HTML Dateien übersetzt und in einem Browser angezeigt werden, sind Links das Salz in der Suppe.
|
||||
Jeder Link hilft dem Anwender schnell an detaillierte Informationen zu gelangen.
|
||||
@@ -148,12 +145,12 @@ So gelangt man zum Abschnitt [Kopfdaten](app.md#kopfdaten) in der Beschreibung z
|
||||
>So gelangt am an den [Kopf](#markdown).
|
||||
>So gelangt man zum Abschnitt [Kopfdaten](app.md#kopfdaten) in der Beschreibung zur Anwendungsdokumentation.
|
||||
|
||||
### Inline Formatierungen
|
||||
## Inline Formatierungen
|
||||
|
||||
Manchmal möchte man auch innerhalb eines Satzes ein Wort hervorheben.
|
||||
Dafür stehen 2 Möglichkeiten zur Verfügung.
|
||||
|
||||
#### Fettschrift
|
||||
### Fettschrift
|
||||
|
||||
Wenn man Worte fett dargestellt haben möchte, kann man diese in `**` klammern.
|
||||
Grundsätzlich erlaubt Markdown auch `__`, davon sollte man aber wegen der einheitlicheren Lesbarkeit absehen.
|
||||
@@ -168,7 +165,7 @@ Dieses **Wort** ist fett geschrieben.
|
||||
|
||||
>Dieses **Wort** ist fett geschrieben.
|
||||
|
||||
#### Kursivschrift
|
||||
### Kursivschrift
|
||||
|
||||
Wenn man Worte kursiv dargestellt haben möchte, kann man diese in `*` klammern.
|
||||
Grundsätzlich erlaubt Markdown auch `_`, davon sollte man aber wegen der einheitlicheren Lesbarkeit absehen.
|
||||
@@ -183,7 +180,7 @@ In Überschriften sollte man möglichst auf die Fettschrift verzichten.
|
||||
|
||||
>*Dieser Satz ist kursiv geschrieben.*
|
||||
|
||||
#### Code
|
||||
### Code
|
||||
|
||||
Dateinamen, Befehle oder Wörter, die aus dem Quellcode übernommen wurden, können in \` geklammert werden.
|
||||
|
||||
@@ -195,7 +192,7 @@ Mit `git pull` holt man den aktuellen Code vom Server.
|
||||
|
||||
>Mit `git pull` holt man den aktuellen Code vom Server.
|
||||
|
||||
#### Zeilenumbruch
|
||||
### Zeilenumbruch
|
||||
|
||||
Manchmal möchte man einen Zeilenumbruch innerhalb eines Absatzes erzwingen.
|
||||
Dies erreicht man, indem man 2 Leerzeichen ans Zeilenende anhängt.
|
||||
@@ -216,12 +213,12 @@ ohne einem Zeilenumbruch.
|
||||
>Dies ist der 2. Absatz.
|
||||
>ohne einem Zeilenumbruch.
|
||||
|
||||
### Listen
|
||||
## Listen
|
||||
|
||||
Listen werden verwendet, wenn man eine Aufzählung von Dingen hat.
|
||||
Sie können auch verschachtelt genutzt werden.
|
||||
|
||||
#### Nummerierte Listen
|
||||
### Nummerierte Listen
|
||||
|
||||
Nummerierte Listen sollten immer mit `1.` und einem Leerzeichen beginnen.
|
||||
Danach folgt der 1 Satz.
|
||||
@@ -244,7 +241,7 @@ Hier folgt der 2. Satz.
|
||||
>1. Dies ist der 3. Eintrag.
|
||||
>6. Falsche Nummern werden korrigiert.
|
||||
|
||||
#### Aufzählungslisten
|
||||
### Aufzählungslisten
|
||||
|
||||
Aufzählungslisten sollten immer mit `-` oder `*` und einem Leerzeichen beginnen.
|
||||
Danach folgt der 1 Satz.
|
||||
@@ -267,7 +264,7 @@ Der Wechsel des Aufzählungszeichens führt zu einer neuen Liste.
|
||||
>* Dies ist der 1. Eintrag einer neuen Liste.
|
||||
>Der Wechsel des Aufzählungszeichens führt zu einer neuen Liste.
|
||||
|
||||
#### Verschachtelte Listen
|
||||
### Verschachtelte Listen
|
||||
|
||||
Man kann auch innerhalb einer Liste eine verschachtelte Liste anlegen.
|
||||
Die Art der Liste kann auch wechseln.
|
||||
@@ -290,7 +287,7 @@ Hier folgt der 2. Satz.
|
||||
1. Dies ist der nächste Eintrag der verschachtelten Liste.
|
||||
- Hier geht die äußere Liste weiter.
|
||||
|
||||
### Tabellen
|
||||
## Tabellen
|
||||
|
||||
In Markdown können einfache Tabellen verwendet werden.
|
||||
In Hinblick auf die Darstellung auf unterschiedlichen Geräten, sollte man keine komplizierten Tabellen anlegen.
|
||||
@@ -329,7 +326,7 @@ Pos. | Beschreibung | Preis
|
||||
>2 | Diskussion | 23,87 EUR
|
||||
>3 <td colspan=2> 2,76 EUR |
|
||||
|
||||
### Hinweis-Boxen
|
||||
## Hinweis-Boxen
|
||||
|
||||
Man kann wichtige Informationen als Hinweisbox darstellen lassen.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user