9to5 Media Services

Markdown 101

Markdown 101

Was ist Markdown?

Markdown ist eine sehr beliebte „leichtgewichtige“ Auszeichnungssprache, die sowohl für Menschen als auch für Computer leicht zu lesen ist. Es lässt sich mit Sicherheit sagen, dass Millionen von Menschen auf Tausenden von Plattformen die verschiedenen Markdown-Varianten für alle denkbaren Zwecke verwenden – von einfachen „Lies mich“-Dateien und Produktdokumentationen bis hin zu komplexen wissenschaftlichen Arbeiten.

Markdown-Dokumente können als solche mit einem Texteditor oder Viewer gelesen oder in viele andere Formate konvertiert werden; normalerweise in HTML, der lingua franca des World Wide Web, aber auch in PDF, EUB und andere Formate.

Bitte beachten Sie, dass es keine „kanonische“ Version von Markdown gibt. Die ursprüngliche Implementierung, die 2004 von John Gruber und Aaron Swartz erstellt wurde, unterstützt die meisten Tags, die ein typischer Autor benötigen würde. Im Laufe der Jahre wurden jedoch viele Variationen und Erweiterungen hinzugefügt.

In diesem Dokument beschränken wir uns auf die grundlegenden Markdown-Elementen und einigen Erweiterungen, die besonders für die technische Dokumentation nützlich sind.

Wie öffnet und bearbeitet man Markdown-Dokumente?

Markdown-Dokumente sind reine Textdateien. Daher können sie in jedem beliebigen Texteditor geöffnet werden.

Die meisten Computer oder mobilen Geräte verfügen über mindestens einen Text- (oder Notizen-)Editor.

Betriebssystem oder Plattform Editor
Apple iOS Notes
Apple macOS TextEdit
Linux vi / vim
Microsoft Windows Notepad
Android -

Standard-Texteditoren für verschiedene Betriebssysteme

Wenn Sie feststellen, dass der Standardeditor Ihren Anforderungen nicht genügt, können Sie aus buchstäblich Tausenden von Texteditoren und Notiz-Apps für die wichtigsten Mobil- und Desktop-Betriebssysteme wählen.

Es gibt auch webbasierte/Online-Texteditoren, darunter einige, für die nicht einmal ein Benutzerkonto oder irgendeine Einrichtung erforderlich ist, wie zum Beispiel Riseup Pad.

Es gibt auch spezielle Markdown-Editoren. Eine (unvollständige) Liste von Markdown-Editoren und -Konvertern finden Sie auf der Seite „Tools“ auf der Website „Markdown Guide“. Sie können auch im Online-App-Store Ihres Betriebssystems nach geeigneten Editoren suchen.

Sie können zum Bearbeiten eines reinen Textdokuments sogar einen Rich-Text-Editor oder ein klassisches Textverarbeitungsprogramm wie Microsoft Word verwenden. In diesem Fall müssen Sie das Markdown-Dokument jedoch als „Nur Text“-Dokument speichern oder exportieren. Wenn Sie lieber mit Ihrem bevorzugten Textverarbeitungsprogramm arbeiten wollen, spricht nichts gegen diesen Workflow. Stellen Sie einfach sicher, dass Sie Ihre Dokumente als Klartext mit UTF-8-Zeichenkodierung speichern.

Wie formatieren Sie Inhalte in Markdown?

Markdown ist kein „What You See Is What You Get“-Format.

In einem typischen Textverarbeitungsprogramm gibt es Menübefehle oder Schaltflächen, mit denen Sie ein Wort zum Beispiel in Fett- oder Kursivschrift formatieren können. Dieses Wort wird dann auf dem Bildschirm sofort in Fett- oder Kursivschrift angezeigt.

In Markdown und anderen vereinfachten Auszeichnungssprachen geben Sie stattdessen einfache Steuercodes ein, die bei der Konvertierung in das richtige Format konvertiert werden.

Hier ist ein Beispiel für ein in Markdown formatiertes Textdokument:

### Markdown zu schreiben ist einfach

In der deutschsprachigen [Wikipedia](https://de.wikipedia.org/wiki/), 
werden Sie eine Menge interessanter Informationen finden. 
__Wissen ist wichtig!__

1. Ein Listenelement
1. Ein weiteres Listenelement

Dieses kurze Dokument kann mit einem Markdown-Editor oder -Konverter in die folgende HTML-Präsentation konvertiert werden:

Markdown zu schreiben ist einfach

In der deutschen Wikipedia finden Sie viele interessante Informationen. Wissen ist wichtig!

  1. Ein Listenelement
  2. Ein weiteres Listenelement

Markdown-Referenz

Hier finden Sie unseren eigenen Markdown-Leitfaden. Weitere Ressourcen:

↻ 2024-06-27