Markdown testen

Spickzettel

Was ist ein Markdown Spickzettel?

Ein Markdown-Spickzettel ist eine schnelle Syntaxreferenz, die Sie beim Schreiben von Dokumentation, README-Dateien, Notizen und Web-Inhalten verwenden können. Anstatt jede Regel auswendig zu lernen, können Sie bewährte Muster für Überschriften, Listen, Links, Tabellen und Codeblöcke kopieren.

Diese Seite wurde für Geschwindigkeit entwickelt: Beispiele sind kopierbereit, basierend auf CommonMark-Konventionen und dem ursprünglichen Markdown-Projekt. Sie funktioniert gut zusammen mit dem Markdown Formatierer und dem Markdown Editor.

Wenn Sie auf Dokumentationsportalen oder in Repositories veröffentlichen, ist Syntaxkompatibilität wichtig. Diese Kurzreferenz enthält Muster, die häufig in der GitHub-Dokumentation und CommonMark-kompatiblen Editoren verwendet werden.

Alles läuft in Ihrem Browser. Ihre Inhalte bleiben auf Ihrem Gerät, während Sie schreiben und die Syntax nachschlagen.

So verwenden Sie den Markdown Spickzettel

Folgen Sie diesen Schritten, um Markdown-Syntax nachzuschlagen und auszuprobieren. Jeder Schritt verwendet die tatsächlichen Panels auf dieser Seite.

Einfügen, Hochladen oder Beispiel laden

Geben Sie Markdown im linken Markdown testen-Panel ein oder fügen Sie es ein, oder klicken Sie auf Hochladen, um eine Datei zu laden. Klicken Sie auf Beispiel, um API-Dokumentation zu sehen. Das rechte Spickzettel-Panel zeigt Basis-Syntax, Code, Tabellen und Aufgabenlisten.

Nachschlagen und Üben

Verwenden Sie den Spickzettel für Überschriften, Hervorhebungen, Links, Codeblöcke und Tabellen. Kopieren Sie Muster in das linke Panel, um sie auszuprobieren. CommonMark- und GitHub-kompatibel.

Kopieren oder Herunterladen

Klicken Sie auf Kopieren oder Herunterladen, um den Spickzettel zu speichern. Verwenden Sie Löschen, um neu zu beginnen. Alle Verarbeitung erfolgt in Ihrem Browser.

Vertrauenswürdige Markdown-Referenzen

Hochautoritative Referenzen, die von Entwicklern, technischen Autoren und Dokumentationsteams verwendet werden:

So nutzen Sie diese Quellen

Verwenden Sie CommonMark als Basis, prüfen Sie plattformspezifisches Verhalten in der GitHub/GitLab-Dokumentation und validieren Sie die gerenderte Ausgabe vor der Veröffentlichung.

Häufige Anwendungsfälle

README schreiben

Verwenden Sie schnelle Syntaxbeispiele beim Erstellen von Projektdokumentation in Repositories.

Technische Notizen

Halten Sie die Formatierung konsistent für Designdokumente, Vorfallsnotizen und Architektur-Updates.

Team-Onboarding

Neue Teammitglieder können funktionierende Syntax kopieren, anstatt jede Regel von Grund auf zu lernen.

Checklisten

Erstellen Sie Deployment-, QA- und Release-Aufgabenlisten mit korrekter Markdown-Checklisten-Formatierung.

Häufig gestellte Fragen

Basiert dies auf Standard-Markdown?

Ja. Die Referenz folgt der weit verbreiteten CommonMark-kompatiblen Syntax. Für formale Regeln siehe die CommonMark-Spezifikation.

Kann ich den gesamten Spickzettel kopieren?

Ja. Verwenden Sie den Kopier-Button, um die gesamte Referenz sofort in Ihre Zwischenablage zu kopieren.

Kann ich ihn als Datei herunterladen?

Ja. Verwenden Sie den Download-Button, um den Spickzettel als .md-Datei zu speichern.

Verlässt mein Text den Browser?

Nein. Alles läuft lokal in Ihrem Browser, wie bei unseren anderen Markdown-Tools.

Kann ich hier Markdown in HTML umwandeln?

Ja. Verwenden Sie Markdown zu HTML, wenn Sie eine Konvertierung benötigen. Für HTML-Semantik siehe die MDN HTML-Dokumentation.

Kann ich unordentliches Markdown formatieren?

Ja. Verwenden Sie den Markdown Formatierer, um Abstände und Struktur zu bereinigen.

Weitere Markdown-Tools

Verwenden Sie diese zusammen mit dem Spickzettel für Schreib-, Formatierungs- und Konvertierungs-Workflows:

Markdown Spickzettel