Zum Hauptinhalt springen

Konvertieren Markdown Zu PDF In Make

Konvertieren Markdown Zu PDF ist ein Make Modul von PDF4me das eine .md-Datei oder eine ZIP Archiv von Markdown in ein poliertes PDF Dokumentieren Sie es innerhalb Ihres Automatisierungsszenarios. Verwenden Sie es, um README-Dateien, technische Dokumentationen oder Wiki-Exporte zu veröffentlichen als PDFs. Das Modul erhält Überschriften, Codeblöcke, Tabellen und Hervorhebungen in der Ausgabe.

Verwandte Blog-Beiträge
Zu dieser Funktion gibt es noch keinen Blogbeitrag – folgt in Kürze.
Schauen Sie sich in der Zwischenzeit im PDF4me-Blog Tutorials und Arbeitsabläufe für alle Plattformen an.
Besuchen Sie den Blog

Authentifizierung Ihres API Anfrage

Um auf die PDF4me Web API durch MakeJede Anfrage muss die entsprechenden Authentifizierungsdaten enthalten. Die Authentifizierung gewährleistet eine sichere Kommunikation und bestätigt Ihre Identität als autorisierter Benutzer, wodurch eine nahtlose Integration zwischen Ihren Systemen ermöglicht wird. Make Szenarien und PDF4me'S Markdown Konvertierungsdienste.

Wichtige Fakten, die Sie nicht verpassen sollten

ZIP Eingabe erfordert das Feld „Markdown-Dateipfad“.
Wenn es sich bei dem Dokument um ein .zip-Archiv handelt, geben Sie im Feld „Markdown-Dateipfad“ den relativen Pfad zur darin enthaltenen .md-Datei an, zum Beispiel: docs/README.mdLassen Sie es leer, um eine direkte .md-Datei zu erstellen; lassen Sie es weg bei einer ZIP Die Eingabe führt zum Fehlschlagen des Moduls.
Die GitHub-typische Formatierung bleibt erhalten
Überschriften, Listen, Fettdruck, Kursivschrift, Inline-Code, Codeblöcke, Tabellen und Zitate werden korrekt dargestellt. Bilder mit relativen Pfaden werden möglicherweise nicht geladen; verwenden Sie daher absolute Pfade. URLs für eingebettete Bilder.
Verwenden Sie einen Iterator, um einen gesamten Dokumentationssatz zu konvertieren.
Das Modul wandelt eins um Markdown Eine Datei pro Durchlauf. Um einen Ordner mit .md-Dateien zu verarbeiten, platzieren Sie vor diesem Modul einen Repeater oder Iterator, sodass in jeder Iteration eine Datei verarbeitet wird.
Das PDF4me-Modul „Markdown in PDF konvertieren“ in Make zeigt die Felder „Verbindung“, „Dateiname“, „Dokument“ und „Markdown-Dateipfad“ an.

Wählen Sie Ihre PDF4me Verbindung herstellen, Dateinamen und Dokument aus dem vorherigen Download-Schritt zuordnen und dann den Markdown-Dateipfad nur dann festlegen, wenn das Dokument ein ZIP Archiv.

Was ist Convert? Markdown Zu PDF In Make?

Konvertieren Markdown Zu PDF Ist Make'S PDF4me Modul zum Rendern Markdown Quelle in eine PDF Dokumentation programmatisch. Es akzeptiert eine .md-Datei oder eine ZIP Archiviert als Binärpuffer und gibt ein formatiertes Ergebnis zurück PDFIm Gegensatz zu einem einmaligen Online-Konverter läuft dieses Modul in einem automatisierten Szenario, sodass jede neue README-Datei, jede Dokumentenaktualisierung oder jeder Wiki-Export eine PDF Version ohne manuelle Schritte.

Parameter

ParameterErforderlichWas es tutBeispiel
ConnectionRequiredPDF4me connection holding your API key. Create one from the Make Connections panel using your key from dev.pdf4me.com/dashboard.TestUser01
File NameRequiredMarkdown filename with a .md extension, or .zip for a ZIP archive containing Markdown. Map it from the prior module output. Drives the output PDF name.README.md
DocumentRequiredBinary Markdown or ZIP file content as a Make buffer. Map from the Data field of a GitHub, GitLab, Dropbox, or HTTP download module.1. Data
Markdown File PathConditionalRelative path to the .md file inside a ZIP archive. Required only when Document is a ZIP; leave empty for a direct .md file.docs/README.md

Ausgabe

FeldTypWas es enthält
NameStringOutput PDF filename derived from the Markdown source filename. Use it in the destination upload module File Name field.
Doc DataBufferBinary PDF content rendered from the Markdown source. Map directly into a cloud-storage upload module, an email attachment, or a merge step.

Wie funktioniert die Umwandlung? Markdown Zu PDF Arbeit in Make?

Das Modul liest die Markdown Der Puffer, den Sie ihm zuweisen, rendert Überschriften, Listen, Tabellen, Codeblöcke und Hervorhebungen in einem festen Layout und streamt das Ergebnis zurück. PDF im Feld „Dokumentdaten“. Für ein ZIP Zuerst wird die im Markdown-Dateipfad angegebene Datei extrahiert, dann wird nur diese Datei gerendert. Markdown selbst folgt dem CommonMark-SpezifikationDie GitHub-Variante erweitert dies um Tabellen und Aufgabenlisten, wie in der Dokumentation beschrieben. GitHubs Markdown-LeitfadenBeispiele für Szenario-Erstellungsmuster finden Sie unter Hilfezentrum erstellenDie

Typische Konfigurationen

README-PDF auf GitHub-Veröffentlichung
  1. Auslösen bei einer neuen Version, die in einem GitHub-Repository erstellt wird.
  2. Laden Sie die Datei README.md aus dem Repository herunter.
  3. Dateinamen und Dokument an Convert übergeben Markdown Zu PDFDie
  4. Fügen Sie die zurückgesendete Datei bei. PDF zu den GitHub-Release-Assets.
Stapelkonvertierung eines Dokumentationsordners
  1. Mit dem GitLab- oder Dropbox-Listenmodul lassen sich alle .md-Dateien in einem Dokumentenordner auflisten.
  2. Durchlaufe die Liste und lade jede Datei herunter.
  3. Konvertierung ausführen Markdown Zu PDF bei jeder Iteration.
  4. Laden Sie jedes einzelne hoch PDF zu einem Dokumentationsportal oder einem gemeinsamen Laufwerk.
Archivieren Sie einen Wiki-Export als PDF
  1. Wiki-Seiten exportieren als ZIP von Markdown Dateien aus Confluence oder dem GitLab-Wiki.
  2. Karte der ZIP Im Puffer speichern Sie das Dokument und legen den Markdown-Dateipfad auf die gewünschte Seite fest.
  3. Konvertierung ausführen Markdown Zu PDF für jeden Seitenpfad.
  4. Speichern Sie das Ergebnis PDFs in einem Google Drive-Archivordner.

Praktische Tipps

Markdown-Dateipfad nur festlegen für ZIP Eingabe
Lassen Sie dieses Feld leer, wenn es sich bei dem Dokument um eine direkte .md-Datei handelt. Das Weglassen dieses Feldes bei einem ZIP Die Eingabe führt dazu, dass das Modul fehlschlägt, da es keine zu rendernde Datei finden kann.
Absolutes Bild verwenden URLS
Relative Bildpfade in der Markdown Die Quelle kann zur Renderzeit möglicherweise nicht aufgelöst werden. Verweisen Sie Bildreferenzen auf ein vollständiges https:// URL also erscheinen sie in der PDFDie
Die Dateierweiterung im Dateinamen beibehalten
Fügen Sie .md oder .zip in den Dateinamen ein, damit das Modul und nachfolgende Module das Quellformat korrekt erkennen.
Für mehrere Dateien wiederholen
Das Modul rendert eins Markdown Quelle pro Durchlauf. Platzieren Sie einen Repeater oder Iterator davor, um einen gesamten Ordner mit .md-Dateien zu verarbeiten.
Guthaben wird pro Umwandlung verbraucht
Jeder Durchlauf verbraucht PDF4me Guthaben aus Ihrem Tarif. Überprüfen Sie Ihre Dashboard-Nutzung, bevor Sie eine große Stapelkonvertierung planen.

Spickzettel

FeldWert
ModulePDF4me > Convert Markdown to PDF
ConnectionYour PDF4me connection (key from dev.pdf4me.com/dashboard)
File NameREADME.md
Document1. Data (binary from prior download)
Markdown File Pathdocs/README.md (ZIP input only)
OutputDoc Data (rendered PDF buffer)

Häufig gestellte Fragen

Wie konvertiere ich? Markdown Zu PDF In Make?+
Füge die PDF4me Konvertieren Markdown Zu PDF Modul zu einem Make Szenario, Verbindung herstellen, Dateiname und Dokument aus einem vorherigen Download-Schritt zuordnen und das Szenario ausführen. Das Modul gibt ein gerendertes Ergebnis zurück. PDF im Feld „Dokumentdaten“ ohne manuellen Konvertierungsschritt.
Kann ich ein ZIP Datei von Markdown Dokumente auf einmal?+
Das Modul wandelt eins um Markdown pro Lauf eine Datei, aber diese Datei kann aus einem internen Prozess stammen ZIP Archivierung, wenn Sie den Markdown-Dateipfad auf den relativen Pfad der .md-Datei im Archiv festlegen ZIPUm einen Ordner mit einzelnen .md-Dateien zu konvertieren, führen Sie das Modul einmal pro Datei innerhalb eines Make Iterator.
Warum werden meine Bilder in der konvertierten Liste nicht angezeigt? PDF?+
Bilder, auf die über einen relativen Pfad verwiesen wird Markdown Die Quelle kann möglicherweise nicht aufgelöst werden, wenn die PDF wird gerendert. Absolute Werte verwenden URLs für eingebettete Bilder, damit diese im Ausgabefenster korrekt geladen werden. PDF. Der GitHub Markdown-Leitfaden behandelt die Bildsyntax im Detail.
Welche Markdown-Formatierungen unterstützt das Modul?+
Das Modul bewahrt die GitHub-typischen Eigenschaften. Markdown Elemente wie Überschriften, geordnete und ungeordnete Listen, Fettdruck und Kursivschrift, Inline-Code, Codeblöcke, Tabellen und Blockzitate folgen dem CommonMark-Spezifikation dass GitHub Flavored Markdown erweitert wird.

Branchenspezifische Anwendungsfälle und Anwendungen

  • README-Dokumentation: README-Dateien für Releases in PDF konvertieren
  • API-Dokumentation: PDF-Dokumente aus Markdown generieren
  • Änderungsprotokolle: Konvertiere CHANGELOG.md in das PDF-Format
  • Leitfäden für Mitwirkende: PDF-Anleitungen aus Markdown erstellen

Verwandte Aktionen

Dieselbe Aufgabe auf anderen Plattformen

Hilfe erhalten