Mit Markdown halten Entwickler, Autoren und Notiz-Apps Text als reinen Text lesbar und kennzeichnen trotzdem Überschriften, Listen und Hervorhebungen. Die meisten Leser können es jedoch nicht formatiert öffnen. Markdown in PDF wandelt die Datei mit Pandoc um und stellt sie als gestaltetes Dokument dar, sodass aus einer README, einer Besprechungsnotiz oder einer Dokumentation eine PDF wird, die jeder lesen kann.
So verwenden Sie Markdown in PDF
- Fügen Sie die .md- oder .markdown-Datei hinzu.
- Wählen Sie In PDF umwandeln.
- Laden Sie die PDF herunter.
- Prüfen Sie Tabellen, Codeblöcke und Links im Ergebnis.
Was formatiert wird
Pandoc versteht die gängige Markdown-Syntax: Überschriften, Absätze, Fett- und Kursivschrift, nummerierte und unnummerierte Listen, Zitatblöcke, Links, horizontale Linien, abgegrenzte Codeblöcke und Tabellen mit senkrechten Strichen. Daraus wird HTML, das anschließend auf PDF-Seiten gesetzt wird, und Links bleiben in der PDF anklickbar. In TeX geschriebene mathematische Notation wird nicht als Formel gesetzt, daher brauchen stark mathematische Dokumente ein eigenes Satzprogramm.
Bilder und Server ohne Pandoc
Das Werkzeug wandelt eine einzelne Markdown-Datei um, daher sind über relative Pfade eingebundene Bilder nicht verfügbar, und Bilder von Webadressen werden aus Sicherheitsgründen blockiert. Wandeln Sie Diagramme bei Bedarf separat mit Bilder in PDF um. Die Formatierung setzt voraus, dass Pandoc auf dem Server installiert ist; fehlt es, erzeugt VelloDoc trotzdem eine PDF, zeigt das Markdown aber als reinen Text mit sichtbaren Symbolen.
Arbeitsabläufe für Dokumentation
Markdown in PDF eignet sich, um Dokumentation mit Menschen außerhalb eines Code-Repositorys zu teilen, etwa mit Kunden, Prüfern oder Führungskräften. Fassen Sie mehrere umgewandelte Dateien mit PDF zusammenfügen zu einem Handbuch zusammen und nummerieren Sie die Seiten mit Seitenzahlen hinzufügen. Für einfache Notizen ohne Struktur reicht TXT in PDF, und PDF in Markdown holt Text wieder heraus. Der Leitfaden zu Formaten erklärt die Vor- und Nachteile.
Wann Markdown in PDF hilft
README-Dateien für Nicht-Entwickler
Geben Sie Kunden oder Führungskräften eine lesbare PDF der README eines Projekts, ohne dass sie ein Repository durchsuchen müssen.
Besprechungsnotizen und Journale
Machen Sie aus Notizen in Markdown-Apps Dokumente, die Sie ablegen, drucken oder als Protokoll versenden können.
Technische Dokumentation
Stellen Sie Einrichtungsanleitungen und Betriebshandbücher als PDFs für Audits, Übergaben oder die Offline-Nutzung zusammen.
Grenzen des Tools
Markdown in PDF wandelt jeweils eine Datei um, daher werden relative Bilder nicht übernommen und externe Bilder blockiert. TeX-Formeln werden nicht gesetzt. Die vollständige Formatierung setzt Pandoc auf dem Server voraus; ohne Pandoc ist die Ausgabe reiner Text. WeasyPrint wird ebenfalls benötigt.
Markdown in PDF: häufige Fragen
Welche Markdown-Syntax wird unterstützt?
Überschriften, Hervorhebungen, Listen, Zitatblöcke, Links, abgegrenzte Codeblöcke, horizontale Linien und Tabellen mit senkrechten Strichen werden über Pandoc unterstützt.
Warum fehlen meine Bilder?
Nur die Markdown-Datei selbst wird hochgeladen, daher werden über relative Pfade eingebundene Bilder nicht gefunden, und externe Bilder werden blockiert. Wandeln Sie Bilder separat um und fügen Sie die PDFs bei Bedarf zusammen.
Warum zeigt meine PDF rohe Markdown-Symbole?
Auf dem Server ist Pandoc nicht installiert, daher wurde die Datei als reiner Text dargestellt. Ein Server mit Pandoc erzeugt eine formatierte Ausgabe.
Wird Code mit Syntaxhervorhebung dargestellt?
Codeblöcke behalten ihr Layout in Festbreitenschrift und ihre Zeilenumbrüche. Die farbige Hervorhebung hängt von der Pandoc-Version des Servers ab, verlassen Sie sich für das Verständnis des Codes also nicht darauf.