CDRN

Markdown umwandeln und in der Vorschau anzeigen

  • Dashboard
  • Dokumentation
  • API
wandelt Ihr Markdown in HTML um und zeigt eine Live-Vorschau an, ideal zum Verfassen von READMEs, Dokumentationen oder Artikeln

Was ist Markdown?

Markdown ist eine leichtgewichtige Auszeichnungssprache, die 2004 von John Gruber entwickelt wurde. Sie ermöglicht das Schreiben von formatiertem Text mit einer einfachen, auch im Rohzustand lesbaren Syntax, die anschließend in HTML umgewandelt wird.

Dieses Werkzeug verwendet die Spezifikation GFM (GitHub Flavored Markdown), die am weitesten verbreitete Variante, die die Unterstützung von Tabellen, Kontrollkästchen, Codeblöcken mit Syntaxhervorhebung und automatischen Links hinzufügt.

Die Vorschau rechts wird während des Tippens in Echtzeit aktualisiert. Die Schaltfläche Absenden erzeugt den entsprechenden HTML-Code, den Sie kopieren oder herunterladen können.

Grundlegende Markdown-Syntax

MarkdownErgebnis
# Überschrift 1Überschrift <h1>
## Überschrift 2Überschrift <h2>
**fett**fett
*kursiv*kursiv
`Inline-Code`Inline-Code
```php ... ```PHP-Codeblock
[Text](url)Hyperlink
![alt](url)Bild
- ElementUngeordnete Liste
1. ElementGeordnete Liste
> ZitatBlockquote
---Horizontale Trennlinie

Häufige Anwendungsfälle

  • GitHub README: Schreiben der Dokumentation eines Open-Source-Projekts.
  • Technische Dokumentation: Schreiben von Anleitungen, Wikis oder Dokumentationsseiten (MkDocs, Docusaurus, Hugo).
  • Blogartikel: Die meisten CMS (Jekyll, Ghost, Contentful) akzeptieren Markdown.
  • Kommentare und Issues: GitHub, GitLab, Jira, Notion und Slack unterstützen alle GFM.
  • Formatierte E-Mails: Umwandlung von Markdown in HTML zur Einbindung in eine HTML-E-Mail.
  • Notizen und Präsentationen: Obsidian, Notion, Marp und Reveal.js verwenden Markdown.

Häufig gestellte Fragen

Was ist der Unterschied zwischen Standard-Markdown und GFM?

Standard-Markdown (CommonMark) deckt die grundlegenden Elemente ab: Überschriften, Listen, Links, Code. GFM (GitHub Flavored Markdown) fügt Tabellen, Aufgabenlisten (- [ ] Element), umschlossenen Code mit Sprache (```php), Erwähnungen und automatische Links hinzu. Dieses Werkzeug verwendet GFM über die Bibliothek league/commonmark.

Ist das generierte HTML sicher?

Ja. Der Konverter ist so konfiguriert, dass er rohe HTML-Tags entfernt (html_input: strip) und unsichere Links blockiert, was XSS-Angriffe verhindert. Das erzeugte HTML eignet sich zur Einbindung in eine bestehende Webseite.

Kann ich HTML in mein Markdown einfügen?

Aus Sicherheitsgründen wird rohes HTML, das in das Markdown eingefügt wird, bei der Umwandlung entfernt. Wenn Sie eine benutzerdefinierte HTML-Ausgabe benötigen, schreiben Sie das gewünschte HTML direkt.

Wie groß darf das Dokument maximal sein?

Für dieses Werkzeug gibt es serverseitig keine strikte Begrenzung. Bei sehr langen Dokumenten (mehr als einige Tausend Zeilen) kann die Echtzeitvorschau je nach Browser langsamer werden.

Beispielanfrage

curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
  -H "Content-Type: application/json" \
  -d '{"input":"..."}'

Eingabeschema

Feld Typ Erforderlich Standard
input text –

Endpunkte

  • GET https://cdrn.fr/api/v1/tools - listet alle verfügbaren Tools auf
  • GET https://cdrn.fr/api/v1/tools/markdown-formatter - liefert das Schema dieses Tools
  • POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - führt dieses Tool mit einem JSON-Payload aus