Markdown-Dateien

Markdown ist ein beliebtes Textdateiformat für die Erstellung von formatiertem Text. Viele Software-Entwickler verwenden es zum Beispiel für die einfache Erstellung einer Dokumentation. Es verfügt über verschiedene Varianten (auch Flavors genannt). unterstützt die gängigste Variante, CommonMark, und zeigt anhand einer Vorschau an, wie die Datei aussieht, wenn sie in HTML konvertiert wird.

Die CommonMark-Syntax hat sehr komplizierte Regeln für das Schreiben bestimmter Elemente, damit die Konvertierung in HTML so klar wie möglich funktioniert. Dieses Thema behandelt nicht alle Details. Weitere Informationen finden Sie in der aktuellen Version der CommonMark-Spezifikation.

  1. Starten Sie mit dem Importieren einer Markdown-Datei.

  2. Wählen Sie im Fenster Dokument-Importoptionen die MD-Datei aus und klicken Sie auf Filter und Konfiguration ändern.

  3. Das Fenster Einstellungen für Dokumentenimport wird angezeigt. Wählen Sie in der Dropdown-Liste Filter die Option Markdown-Filter aus.

    srt-filter-OPTIONS

Umgang mit Formatierung

Markdown verwendet Sonderzeichen wie Sternchen (*) und Unterstriche (_) für die Formatierung von Text. Die Grundregel lautet: Ein Paar aus einzelnen Sternchen oder Unterstrichen bedeutet kursiv (so wie das HTML-Tag <em>) und ein Paar aus doppelten Sternchen oder Unterstrichen bedeutet fett (so wie das HTML-Tag <strong>).

Umgang mit Zeilenumbrüchen festlegen

Bedingte Zeilenumbrüche (wenn die Zeile mit einem Zeilenumbruch-Zeichen endet):

Harte Zeilenumbrüche (wenn die Zeile mit zwei Leerzeichen oder dem HTML-Tag <br> endet):

Umgang mit Code-Blöcken

In Markdown gibt es zwei Arten von Code-Blöcken:

importiert eingerückte Code-Blöcke immer. Einstellungen unter Code-Blöcke definieren, was mit umrahmten Code-Blöcken passiert.

Auch wenn Sie umrahmte Code-Blöcke nicht zur Übersetzung importieren, werden sie in der Vorschau angezeigt.

Umgang mit HTML-Inhalt

Markdown-Dateien können über HTML-Inhalt verfügen. Wenn sich der HTML-Inhalt in Blöcken von benachbarten Zeilen befindet, können Sie diese als separate eingebettete Dateien unter der Markdown-Datei importieren. Aktivieren Sie hierzu im unteren Bereich des Fensters Dokument-Importoptionen das Kontrollkästchen Eingebettete Objekte importieren.

importiert diese eingebetteten Dateien anhand des eigenen HTML-Filters, der aktuell (Q2 2024) nicht konfigurierbar ist. HTML-Kommentare werden nicht importiert.

HTML-Kommentare in Markdown sehen so aus:
  • Die erste Zeile beginnt mit den Zeichen <!--

  • und die letzte Zeile enthält die Zeichen -->.

Beispiele:

<!-- Dies

ist ein

Kommentar -->

 

<!-- Dies ist ein weiterer Kommentar -->

Wenn ein Kommentar nicht innerhalb eines HTML-Blocks ist (also wenn er sich zwischen den Zeilen von Nicht-HTML-Inhalt befindet), können Sie ihn in die Markdown-Datei selbst importieren. Aktivieren Sie hierzu im HTML-Bereich der Markdown-Filterkonfiguration das Kontrollkästchen HTML-Kommentare der obersten Ebene als zu übersetzenden Text importieren.

In der aktuellen Version von können HTML-Kommentare innerhalb von HTML-Blöcken nicht importiert werden.