Auf der Arbeit bin ich von Zeit zu Zeit gezwungen Einträge im Firmen-Kunden-Wiki zu veröffentlichen. Ich schreibe eigentlich nur gezwungen, weil ich die Wikisyntax so gar nicht mag, denn ansonsten ist es keine schlechte Aufgabe. Dennoch schieb ich es regelmäßig auf. Gleichzeit musste ich mich in der letzten Zeit auf der Arbeit auch ein wenig mit Markdown beschäftigen, weil GitHub ReadMe Dateien gerne in diesem Format sieht.
Atom – der TextEditor von GitHub – unterstützt Markdown nativ und mit ⌃+⇧+M kann man eine Vorschau aktivieren, was es dem Neuling gut und schnell erlaubt mit Markdown Fortschritte zu machen. Während GitHub seine eigene Version von Markdown (GFM) bevorzugt, entspricht diese jedoch im Großen und Ganzen der ursprüngliche Markdown Syntax von John Gruber, die dieser auf Daring Fireball veröffentlicht hat.
Markdown ist eine sehr einfache Markup-Sprache, die es schnell ermöglicht Texte zu formatieren. Angedacht war das Format ursprünglich, um schnell HTML Dateien zu erstellen, ohne dabei die Lesbarkeit der ursprünglichen Inhalte ganz aufzugeben. Das schafft Markdown auch ausgezeichnet und hält sich dabei an viele Vorgaben, die man noch aus der „alten Formatierung“ von Text-Only-E-Mails kennen mag. Da sich das Format nicht mit „übertriebenen“ Formatierungen aufhält, ist diese Markup-Sprache auch rechts schnell zu erlernen. Wie gesagt, Atom hilft indem es eine gute Vorschau gibt.
Als ich also letzte Woche eine längere Dokumentation (15 Seiten) in Markdown formatiert hatte und dann ins Firmeninterne Wiki stellen sollte, war ich der Verzweiflung nahe. Wie konvertiere ich das jetzt, ohne durch die ganzen 15 Seiten durch zu müssen? Die Antwort fand sich zum Glück in Pandoc, einem Command Line Tool von John MacFarlane. Prof. MacFarlane unterrichtet Philosophie an der Universität in Berkley und nutzt das Tool für seien eigenen Arbeiten. Das erklärt sicherlich den LaTeX Support, sowie den Support für ePub Formate, aber das ist hier nicht ganz so wichtig.
Wer Pandoc installiert bekommt einen kleinen Alleskönner zur Konvertierung von Dateiformaten, wie markdown (sowie: reStructuredText, textile, HTML, DocBook, LaTeX, MediaWiki markup, OPML, Emacs Org-Mode, or Haddock markup) in eine große Menge anderen Formate wie HTML (sowie: Microsoft Word docx, OpenOffice/LibreOffice ODT, OpenDocument XML, Ebooks: EPUB version 2 or 3, FictionBook2, Outline Formate: OPML und viele, viele mehr) konvertieren.
Das Tool bedient man über die Befehlszeile (Terminal) und ist zum Glück sehr einfach. Man öffnet den Terminal und gibt dem System die nötigen Infos, z.B. eine einfache Konvertierung von Markdown zur MediaWiki Syntax – womit wir endlich beim Titel des Artikels wären.
pandoc -f markdown -t mediawiki /Users/cwolf/Documents/daringfireball_bsp1.txt -o ~/Documents/darinfirewall_wiki.txt
Die Syntax ist dabei ganz einfach:
-f gibt das Ursprungsformat an
-t das Zielformat
gefolgt vom Pfad und Dateinamen der zu konvertierenden Datei
-o gibt den Pfad & Namen der Zieldatei an
Was dabei rauskommt ist für unser Wiki gerade recht und funktioniert aus meiner Sicht ausgezeichnet :) So einfach kann es sein… Ich würde Euch ja gerne Screenshots geben, aber ganz ehrlich so als Befehlszeilen-Tool ist das so gar nicht „sexy“ ;)
0 Kommentare