Gastbeitrag: Texte mit Markdown und Pandoc erstellen




Ein Gastbeitrag von Jan Fischbach vom Teamworkblog. Vielen Dank dafür!

Stephan hat vor längerer Zeit etwas darüber geschrieben, wie Word mit langen Texten umgeht. Ich muss sagen, dass mir Word seit Jahren gute Dienste leistet. Ich halte meine Dokumente aber auch immer bewusst kurz. Ich stoße mit Word an Grenzen, wenn ich Texte automatisch erstellen und verarbeiten möchte. Beispiele:

  • Ich habe mehrere Textbausteine, die ich zu einem neuen Dokument zusammenfügen will. Außerdem müssen im Text Teile ersetzt werden (Adresse oder Kundennummer).
  • Ich möchte aus verschiedenen Konfigurationsdateien auf dem Server eine lesbare Dokumentation erzeugen.

Bis vor wenigen Jahren wären LaTeX (bzw. MikTeX) oder lout meine erste Wahl gewesen. Aber ich gebe Stephan recht: Man braucht einige Zeit, um sich in darin einzuarbeiten.

Wäre es nicht schön, wenn man seine Dokumente in einer einfachen Textdatei speichern könnte und ein anderes Programm macht daraus einfach HTML, Word, LaTeX oder was wir sonst so brauchen?

Solche Programme gibt es:

  • John Gruber hat das Perlskript Markdown entwickelt. Unterstrichene Texte werden damit zu Überschriften und mit Sternchen leitet man Listen ein. Man kann es auf seiner Webseite direkt ausprobieren.
  • Wer kein Perl benutzen möchte, sollte sich Pandoc von John MacFarlane ansehen. Das Programm läuft unter Windows, Mac und Linux. Es beherrscht viele Dialekte. Der User Guide ist sehr ausführlich. Auch pandoc kann man online direkt testen. Man kann sogar HTML-Präsentationen damit erstellen.

Falls Sie beim Testen Probleme mit deutschen Umlauten haben, versuchen Sie die Textdatei in Unicode zu speichern (UTF-8). Die meisten Text-Editoren erlauben es, die Kodierung zu ändern. Oder Sie nutzen dazu das GNU-Tool iconv, für das es auch eine Windows-Version gibt.

 

BTW: Dieser Beitrag wurde übrigens als Textdatei geschrieben und mit

pandoc -s -f markdown -t html –T
"Gastbeitrag: Texte mit Markdown und Pandoc erstellen"
blogbeitrag.txt > blogbeitrag.html

in HTML umgewandelt.

3 Antworten

3 Gedanken zu „Gastbeitrag: Texte mit Markdown und Pandoc erstellen

  1. Jörg Kliemann

    Ich verwende pandoc seit einiger Zeit mit Begeisterung für alle „herzeigbaren“ Dokumente. Ist auch perfekt, wenn man (mathematische) Formeln in sein Dokument einfügen möchte. Das braucht dann aber Latex-Kenntnisse.
    Als Texteditor nehme ich den Scintilla Texteditor, bei dem ich mir die Umwandlung des gerade bearbeiteten Markdown-Dokuments nach PDF auf den Compile-Menüpunkt gelegt habe.
    Die Erzeugung von PDF-Dokumenten benötigt allerdings eine Software, die Latex (als Zwischenstufe) in PDF umwandelt (bei mir miktex).

    Übrigens: Mit pandoc … -V lang=ngerman … werden alle automatischen Beschriftungen von Tabellen, Bildern … sprachenrichtig geschrieben: als „Tabelle 1: …“ statt „Table 1: …“ bzw. „Abbildung 2: …“ statt „Figure 2: …“

    Antworten
  2. Jörg Kliemann

    Nachtrag zu meinem vorigen Kommentar: miktex braucht bei der Erzeugung von PDF-Dokumenten nicht extra aufgerufen werden; das macht sich pandoc selbst.

    Antworten

Haben Sie eine Frage oder Anregung: Kommentar verfassen