Syntax testen

Syntax-Referenz

Was ist Markdown-Syntax?

Markdown ist eine leichtgewichtige Klartext-Formatierungssprache, die 2004 von John Gruber erstellt wurde. Sie verwendet einfache Symbole und Zeichen zur Textauszeichnung und macht es einfach, Inhalte zu schreiben, die in HTML konvertiert werden, ohne in ihrer Rohform unuebersichtlich auszusehen. Markdown ist zum Standard fuer Dokumentation, README-Dateien, Blogs und alle Inhalte geworden, die einfache, lesbare Formatierung benoetigen.

CommonMark ist die am weitesten verbreitete Spezifikation fuer Markdown, die definiert, wie Parser die Syntax interpretieren sollen. Wenn Sie CommonMark-kompatible Syntax lernen, wird Ihr Inhalt konsistent auf GitHub, GitLab, Discord, Slack, Reddit, Stack Overflow und Dutzenden anderer Plattformen gerendert. Die urspruengliche Markdown-Spezifikation von John Gruber bleibt grundlegend, waehrend Erweiterungen wie GitHub Flavored Markdown Funktionen wie Aufgabenlisten, Durchstreichungen und Tabellen hinzufuegen.

Modernes Markdown kommt in verschiedenen Varianten, die auf bestimmte Plattformen zugeschnitten sind. GitHub Flavored Markdown (GFM) fuegt Tabellen, Checkboxen und Autolinks hinzu. GitLab Markdown unterstuetzt aehnliche Erweiterungen plus Diagramme. Das Erlernen der CommonMark-Kernsyntax gibt Ihnen eine portable Grundlage, die ueberall funktioniert.

So verwenden Sie den Markdown-Syntax-Leitfaden

Folgen Sie diesen Schritten, um Markdown-Syntax zu lernen und auszuprobieren. Jeder Schritt verwendet die tatsaechlichen Panels auf dieser Seite.

Einfuegen, Hochladen oder Beispiel laden

Fuegen Sie Markdown in das linke Panel Syntax testen ein, oder klicken Sie auf Hochladen, um eine .md-Datei zu laden. Klicken Sie auf Beispiel fuer eine Beispiel-API-Dokumentation. Das rechte Panel Syntax-Referenz zeigt CommonMark- und GFM-Muster.

Ueben und Nachschlagen

Verwenden Sie die Referenz fuer Ueberschriften, Hervorhebung, Listen, Links, Tabellen, Codeblocks. Kopieren Sie Beispiele in das linke Panel zum Ausprobieren. Umfasst CommonMark plus GitHub Flavored Markdown-Erweiterungen.

Kopieren oder Herunterladen

Klicken Sie auf Kopieren oder Herunterladen, um die Referenz zu speichern. Verwenden Sie Leeren, um neu zu beginnen. Die gesamte Verarbeitung erfolgt in Ihrem Browser.

Wann Sie dies tatsaechlich verwenden wuerden

Dokumentation schreiben

Technische Dokumentation, API-Referenzhandbuecher und Software-Dokumentation werden fast universell in Markdown geschrieben. Python-Docs, Node.js-Anleitungen und die meisten Open-Source-Projekte verwenden Markdown fuer ihre Dokumentationsseiten. Eine Syntaxreferenz haelt Sie produktiv beim Schreiben komplexer Dokumentation.

README und Projektdateien

Jedes GitHub-Projekt hat eine README.md-Datei, die das Projekt, die Nutzung, Installation und Beitragsrichtlinien beschreibt. Diese Dateien sind vollstaendig in Markdown geschrieben und oft das Erste, was Benutzer sehen.

Content-Erstellung und Veroeffentlichung

Blog-Plattformen wie Jekyll, Hugo und Ghost akzeptieren Markdown fuer Inhalte. Plattformen im Medium-Stil und statische Seitengeneratoren verwenden Markdown als primaeres Eingabeformat. Syntaxkenntnisse helfen Ihnen, schneller zu schreiben und eine konsistente Formatierung beizubehalten.

Kollaborative Kommunikation

Slack, Discord, GitHub Issues, Pull-Request-Kommentare und Forenbeitraege unterstuetzen alle Markdown-Formatierung. Bei Code-Reviews, Fehlerberichten oder Chat-Zusammenarbeit laesst Markdown Sie Ihre Nachricht klar formatieren, ohne den Gespraechsfluss zu unterbrechen.

Haeufig gestellte Fragen (FAQ)

Kann ich HTML innerhalb von Markdown verwenden?

Ja, Markdown erlaubt das Mischen von rohem HTML. Wenn Markdown etwas nicht unterstuetzt, das Sie benoetigen, koennen Sie HTML direkt schreiben und es wird in die Ausgabe durchgereicht. Laut der CommonMark-Spezifikation werden HTML-Bloecke und Inline-HTML erkannt und unveraendert durchgereicht. Verwenden Sie dies sparsam.

Was ist der Unterschied zwischen Sternchen und Unterstrichen fuer Hervorhebung?

Funktional sind sie in CommonMark identisch — *Text* und _Text_ erzeugen beide Kursiv, **Text** und __Text__ erzeugen beide Fett. Die Wahl ist stilistisch. Viele Teams bevorzugen Sternchen aus Gruenden der Konsistenz und weil sie auf den meisten Tastaturen einfacher zu tippen sind.

Wie funktionieren Zeilenumbrueche in Markdown?

Dies ist eine haeufige Quelle der Verwirrung. Ein einzelner Zeilenumbruch in der Quelle wird als Leerzeichen behandelt. Um einen echten Zeilenumbruch (<br> in HTML) zu erzeugen, fuegen Sie zwei Leerzeichen am Zeilenende vor dem Druecken von Enter hinzu, oder verwenden Sie einen Backslash vor dem Zeilenumbruch. Fuer Absatzumbrueche verwenden Sie eine Leerzeile. Die CommonMark-Spezifikation erklaert dies ausfuehrlich.

Werden Tabellen ueberall in Markdown unterstuetzt?

Nein. Tabellen sind Teil von GitHub Flavored Markdown und anderen Erweiterungen, aber sie sind nicht in der CommonMark-Spezifikation. Die meisten modernen Plattformen (GitHub, GitLab, Discord) unterstuetzen sie, aber einige Parser ignorieren die Pipe-Syntax.

Wie escape ich Sonderzeichen?

Verwenden Sie einen Backslash (\) vor Zeichen mit spezieller Bedeutung in Markdown: Backslash (\), Backtick (`), Sternchen (*), Unterstrich (_), geschweifte Klammern ({}), eckige Klammern ([]), runde Klammern (()), Raute (#), Plus (+), Minus (-), Punkt (.) und Ausrufezeichen (!). Zum Beispiel rendert \*kein Kursiv\* die Sternchen woertlich.

Was ist der beste Weg, Code in Markdown zu formatieren?

Fuer Inline-Code verwenden Sie einfache Backticks: `Code hier`. Fuer Codeblocks verwenden Sie dreifache Backticks mit einem optionalen Sprach-Tag (```javascript) fuer Syntaxhervorhebung. Vermeiden Sie das Einruecken von Code als Codeblock — eingezaeunte Codeblocks sind klarer und portabler.

Markdown-Syntax-Leitfaden