3 KiB
Einführung in Markdown
Hier erfährst du, was Markdown ist und wie du Markdown-Dokumente erstellen kannst.
Was ist Markdown?
Markdown hat Ähnlichkeiten mit einer Computersprache, ist aber wesentlich einfacher konzipiert und soll so für jeden verständlich sein. Markdown ermöglicht es, Texte im Web zu formatieren, ohne das betreffende Dokument dazu mit eckigen Klammern, Befehlen und sonstigen Kommandos zu überfluten, wie man sie für ein gestyltes HTML-Dokument normalerweise benötigt. Ein Markdown-Dokument soll übersichtlich bleiben und auch im Rohformat angenehm zu lesen sein. Deswegen verwendet Markdown einfache Zeichen zur Formatierung von Text, zum Beispiel Sternchen und Unterstriche anstelle von eckigen Klammern und langen Befehlen.
Wie erstelle ich in Git ein Markdown-Dokument?
Gehe in Git auf "Datei hinzufügen" und wähle "Neue Datei":
Dann siehst du ein leeres Dokument. Der Text kann wie folgt eingetragen werden:
Markdown-Test
Dieser Text soll fett geschrieben werden.
Und dieser Absatz soll kursiv angezeigt werden.
Das ist quasi der Code. In der Vorschau siehst du, wie das Dokument dann aussieht.
Das Beispiel zeigt bereits einige der wichtigsten Markdown-Auszeichnungen:
-
Überschriften: Überschriften werden einfach mit Rauten ausgezeichnet. Die Anzahl der Rauten entspricht der Ordnung der Überschriften. Eine Headline dritter Ordnung würde also so aussehen: ### Headline 3
-
Fettschreibung und Kursivierung: Um einen Text fett oder kursiv zu setzen, genügt es in Markdown, den entsprechenden Abschnitt in Sternchen zu setzen. Ein Sternchen bedeutet „kursiv“, zwei Sternchen bedeuten „fett“. Kursiv bzw. Fett
-
Links hinzufügen: [Beschreibung](Link zur Beschreibung) oder einfach den Link per Copy & Paste einfügen
Markdown unterstützt deutlich mehr Formatierungen, etwa das Setzen von Links oder Einbinden von Bildern. Alle Details dazu findet man in der sehr übersichtlichen Markdown-Dokumentation von Daring Fireball oder in der Doku speziell zum Thema Bilder.
Das Beispiel zeigt, wie sinnvoll der Einsatz von Markdown ist, gerade in Bereichen, wo auch Menschen ohne Code-Hintergrund in Kontakt mit den betroffenen Texten kommen. Aus diesem Grund gibt es inzwischen viele Content-Management Systeme, die auch mit Markdown-Inhalten bestückt werden können. Ein solcher Editor kombiniert die Vorteile eines Reintext-Editors (ressourcenschonend und keine Probleme bei der Darstellung einer Vorschau) mit der guten Lesbarkeit und Übersichtlichkeit.
Bildgröße formatieren
Hier am besten html verwenden.
Sollte im Markdown-Code so aussehen: (Achtung - hier Quelltext anschauen)
[Bild]
Markdown Editoren
- https://pad.gwdg.de/ (wir sind im Gespräch mit GWDG bzgl. Academic ID für das CI)
- https://pad.degrowth.net/
- https://hack.allmende.io/
- https://liascript.github.io/LiveEditor/