Das kleine Einmaleins von Markdown
Ziel
Ich kann in Markdown Überschriften, Listen, Codeblöcke, Blockzitate und Hyperlinks ausdrücken
Hintergrund
Sie werden im gesamten ProPra neben Kommandoeingaben bzw. Kommandoausgaben auch an vielen Stellen selbst Texte schreiben, um etwas zu erklären oder über ein Thema zu reflektieren.
Dazu verwenden wir die schön simple Notation "Markdown".
Arbeitsschritte
Markdown ist eine Markup-Sprache, die einfach schreibbar und gut lesbar ist.
Man kann damit schnell und einfach strukturierte Texte schreiben.
Die Dateiendung für Markdown-Dateien ist .md
.
Lesen Sie diese
Beschreibung der wichtigsten Elemente von Markdown-Dokumenten.
Mit etwas Übung sind Markdown-Texte auch in ihrer Rohform gut lesbar.
Allerdings hilft es gerade am Anfang, direkt zu sehen, was das Markup im Text bewirkt.
Dafür gibt es in den gängigen Editoren Plugins, die direkt die "hübsche" Version zeigen.
Damit Sie direkt sehen können, wie der von Ihnen geschriebene Markup-Text aussieht,
können Sie gerne einen Online-Editor wie StackEdit.io verwenden.
- 1 Erstellen Sie die Datei
Markdown.md
und machen Sie einen Commit mit dieser Datei.
Welche Formatierungmöglichkeiten gibt es in Markdown?
Text Decoration
Text kann fett oder kursiv sein.
- 2 Schreiben Sie in der Datei Text wie den obigen.
Überschriften
Bis zu diesem Zeitpunkt wurden hier in diesem Dokument (das ursprünglich ebenfalls in Markdown geschrieben ist) vier Überschriftenebenen benutzt.
- 3 Erstellen Sie ein Layout mit fünf Überschrift-Ebenen.
Listen
Auflistungen sind wichtig. Manchmal sind sie ungeordnet.
- Sie erlauben Hervorhebung und Vergleiche.
- Sie erlauben auch Trennung von Gedanken.
Manchmal wollen wir aber Gedanken ordnen.
- Das
- funktioniert
- so.
Man kann beide Arten von Listen auch verschachteln:
- Das ist die erste Ebene.
- Das ist die zweite Ebene.
- Wieder zweite Ebene.
- Und eine dritte Ebene gibt es auch!
- Jawoll!
- Das ist die erste Ebene.
- Das ist die zweite Ebene.
- Wieder zweite Ebene.
- Und eine dritte Ebene gibt es auch!
- Jawoll!
Markdown hat zahlreiche Dialekte, d.h. nicht alle Markdown-Implementierungen funktionieren gleich. Wer halbwegs sicher sein will, sollte bei allen Verschachtelungen jeweils 4 zusätzliche Leerzeichen weit einrücken.
Eine "offizielle" Spezifikation gibt es nicht. Am ehesten kommt noch die Urfassung infrage. Eine besonders wichtige Variante ist GitHub-Markdown
- 4 Erstellen Sie eine verschachtelte Auflistung.
Code-Blöcke
Häufig ist es nützlich, ein paar Code-Zeilen zu zeigen, z.B. folgenden Python-Code:.
1 2 3 |
|
- 5 Erstellen Sie einen Codeblock, der die Syntax von
bash
erwartet.
Blockzitate
Manchmal will man etwas zitieren.
Manchmal will ein Zitat zitiert werden.
- 6 Erstellen Sie das Zitat
"Es ist nichts beständiger als die Unbeständigkeit.", Immanuel Kant.
Was gibt es noch?
Man kann auch Bilder einfügen, Tabellen schreiben, per CSS das Aussehen der Markdown-Dateien ändern und noch vieles mehr; siehe die oben genannten Quellen.
Abgabe
Geben Sie das Dokument Markdown.md
mit den im Text unter 1, 2, …
geforderten Markdown-Formatierungen ab.
Geben Sie die Marker mit an.
Dort, wo keine expliziten Texte gefordert sind, dürfen Sie diese frei wählen. Aber halten Sie diese kurz, es geht um die Formatierungen!