Dr. Jekyll and Mr. Markdown

Workshop TA09 auf der tekom Jahrestagung 2017

Markdown Cheat-Sheet

Kurzreferenz für wichtige Auszeichungsmöglichkeiten in Markdown.

Inhaltsverzeichnis

Überschriften
Hervorhebung
Zeilenumbrüche
Listen
Links
Bilder
Code-Beispiele
Tabellen
HTML-Elemente
Linien

Überschriften

# H1
## H2
### H3
#### H4
##### H5
###### H6

H1

H2

H3

H4

H5
H6

Hervorhebungen

*Dieser Text erscheint kursiv.*
_Dieser auch._

**Dieser Satz ist voll fett**.
__Aber dieser auch__.

**Man kann auch _kombinieren_**.

Ergebnis:

Dieser Text erscheint kursiv. Dieser auch.

Dieser Satz ist voll fett. Aber dieser auch.

Man kann auch kombinieren.

Zeilenumbrüche

Zeilenumbrüche sind eigentlich ganz einfach, aber manchmal braucht man eine Leerzeile mehr, als man denkt. Im Zweifelsfall einfach ausprobieren.

Fangen wir mit einer einfachen Zeile an.

Um einen neuen Absatz zu erzeugen, fügen Sie zwischen den Sätzen eine leere Zeile ein.

Anders in diesem Beispiel.
Dieser Satz beginnt im selben Absatz wie sein Vorgänger.

Ergebnis:

Fangen wir mit einer einfachen Zeile an.

Um einen neuen Absatz zu erzeugen, fügen Sie zwischen den Sätzen eine leere Zeile ein.

Anders in diesem Beispiel. Dieser Satz beginnt im selben Absatz wie sein Vorgänger.

Listen

Ungeordnete Liste

Einrückungen werden durch Leerzeichen erzeugt:

* Eintrag 1
* Eintrag 2
  * Eingerückt 2a
  * Eingerückt 2b
    * Eingerückt 2aa

Ergebnis:

Anstelle von Sternchen geht auch was anderes:

* Sternchen
- Minuszeichen
+ Pluszeichen

Ergebnis:

Geordnete Listen

Die Zahl als solche spielt keine Rolle, sofern es sich um eine Zahl handelt:

2. Eintrag 1
0. Eintrag 2
   1. Eingerückt 2a
   7. Eingerückt 2b

Ergebnis:

  1. Eintrag 1
  2. Eintrag 2
    1. Eingerückt 2a
    2. Eingerückt 2b

Kombiniert geht natürlich auch

1. Erster Aufzählungspunkt. 
   * Ungeordnete eingerückte Liste.
   * Zweiter Listeneintrag.
     1. Und noch ne Ebene.
     1. Reicht langsam.

Ergebnis:

  1. Erster Aufzählungspunkt.
    • Ungeordnete eingerückte Liste.
    • Zweiter Listeneintrag.
      1. Und noch ne Ebene.
      2. Reicht langsam.

Für das Erzeugen von Links gibt es viele Möglichkeiten, hier die einfachsten.

[Link zu Tagungsseite](http://tagungen.tekom.de/h17/tekom-jahrestagung-2017/)

ACHTUNG: im Link nicht das http:// vergessen.

URLs ohne alles werden automatisch zu Links: www.tagungen.tekom.de

[Link mit relativem Pfad zu anderer Datei: [Startseite](/tekom2017_markdown_workshop_1/)

Ergebnis:

Link zu Tagungsseite

URLs ohne alles werden automatisch zu Links: www.tagungen.tekom.de

Link mit relativem Pfad zu anderer Datei: Startseite

Bilder

![tekom Logo](http://tagungen.tekom.de/fileadmin/templates/doctima/images/tekom_deutschland.png)

Bilder funktionieren so ähnlich wie Links:

tekom Logo

Codebeispiele

Dieses Cheat-Sheet verwendet viele Beispiele, die den Quelltext der Markdown-Datei zeigen. Damit diese Beispiele nicht formatiert darsgestellt werden, kann man sie mit `Akzentzeichen` umklammern. So sieht es dann aus: Akzentzeichen.

``` Für ganze Abschnitte benötigen Sie sogar 3 Akzentzeichen (davor und danach). ```

        Das Ergebnis sieht dann so aus.

Außerdem können Sie <code>Tags verwenden</code>.

Tabellen

Markdown an sich unterstützt keine Tabellen, aber in vielen Markdown-Ausprägungen (Flavors) können Sie mit Pipe-Zeichen oder evtl. HTML-Tabellen arbeiten. Mit Doppelpunkten geben Sie ganz einfach die Spaltenausrichtung an.


| Tabellen    | Sind           | Toll  |
| ------------- |:-------------:| -----:|
| Spalte 3 ist| rechts  | ausrichtet|
| Spalte 2 | dagegen |   zentriert |

Ergebnis:

Tabellen Sind Toll
Spalte 3 ist rechts ausrichtet
Spalte 2 dagegen zentriert

HTML-Elemente

An vielen Stellen funktionieren auch HTML-Elemente in Markdown.

<dl>
  <dt>Definition list</dt>
  <dd>Dieser Listentyp wird gern verwendet.</dd>

  <dt>Ist fast wie XML</dt>
  <dd>Aber dann können Sie ja auch gleich <em>XML</em> schreiben.</dd>
</dl>

Ergebnis:

Definition list
Dieser Listentyp wird gern verwendet.
Ist fast wie XML
Aber dann können Sie ja auch gleich XML schreiben.

Linien

Drei oder mehr ist die magische Zahl für Linien...

---

Es geht mit Bindestrichen

***

...Sternchen

___

...oder Unterstrichen

Ergebnis:


Es geht mit Bindestrichen


…Sternchen


…oder Unterstrichen


Weiterführende Informationen:

Build at: 2017-10-25 13:08:32 +0000.