Aller au contenu principal

Convertir Markdown à PDF dans Make

Convertir Markdown à PDF est un Make module par PDF4me qui transforme un fichier .md ou un ZIP archives de Markdown dans un poli PDF Intégrez ce document dans votre scénario d'automatisation. Utilisez-le pour publier des fichiers README, des documents techniques ou des exportations wiki. PDFs. Le module préserve les titres, les blocs de code, les tableaux et la mise en évidence dans le document final.

Articles de blog connexes
Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.
En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.
Consultez le blog

Authentification de votre API Demande

Pour accéder au PDF4me Web API à travers MakeChaque requête doit inclure des informations d'authentification valides. L'authentification garantit une communication sécurisée et valide votre identité en tant qu'utilisateur autorisé, permettant une intégration fluide entre vos Make scénarios et PDF4me's Markdown Services de conversion.

Informations importantes à ne pas manquer

ZIP La saisie nécessite le champ Chemin du fichier Markdown
Lorsque le document est une archive .zip, renseignez le champ Chemin du fichier Markdown avec le chemin relatif vers le fichier .md qu'elle contient, par exemple : docs/README.mdLaissez ce champ vide pour un fichier .md direct ; l'omettre pour un fichier .md ZIP L'entrée provoque une défaillance du module.
La mise en forme propre à GitHub est préservée
Les titres, les listes, le gras et l'italique, le code intégré, les blocs de code délimités, les tableaux et les citations s'affichent correctement. Les images référencées par un chemin relatif peuvent ne pas se charger ; utilisez donc un chemin absolu. URLs pour les images intégrées.
Utilisez un itérateur pour convertir un ensemble de documentation complet.
Le module convertit un Markdown Un fichier par exécution. Pour traiter un dossier de fichiers .md, placez un Repeater ou un Iterator avant ce module afin que chaque itération traite un fichier.
Module PDF4me Convertir Markdown en PDF dans Make affichant les champs Connexion, Nom du fichier, Document et Chemin du fichier Markdown

Sélectionnez votre PDF4me connexion, mapper le nom du fichier et le document de l'étape de téléchargement précédente, puis définir le chemin du fichier Markdown uniquement lorsque le document est un ZIP archive.

Qu'est-ce que Convert ? Markdown à PDF dans Make?

Convertir Markdown à PDF est Make's PDF4me module de rendu Markdown source dans une PDF Il accepte un document par programmation. Il accepte un fichier .md ou un ZIP archive sous forme de tampon binaire et renvoie un formatage PDFContrairement à un convertisseur en ligne ponctuel, ce module s'exécute dans un scénario automatisé, de sorte que chaque nouveau fichier README, mise à jour de documentation ou exportation de wiki est automatiquement convertie. PDF version sans étapes manuelles.

Paramètres

ParamètreRequisCe que cela faitExemple
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

Sortir

ChampTaperCe qu'il contient
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.

Comment fonctionne Convert ? Markdown à PDF travailler dans Make?

Le module lit le Markdown Le tampon que vous y mappez, affiche les titres, les listes, les tableaux, les blocs de code et la mise en évidence selon une mise en page fixe, et renvoie le résultat sous forme de flux. PDF dans le champ Données du document. Pour un ZIP Il extrait d'abord le fichier spécifié dans le chemin de fichier Markdown, puis affiche uniquement ce fichier. Markdown elle-même suit le Spécification CommonMarket la version GitHub l'étend avec des tableaux et des listes de tâches, comme indiqué dans la documentation. Guide Markdown de GitHubPour des exemples de scénarios, voir… Créer un centre d'aide.

Configurations typiques

Fichier README PDF disponible sur GitHub
  1. Déclencher une nouvelle version créée dans un dépôt GitHub.
  2. Téléchargez le fichier README.md depuis le dépôt.
  3. Transmettez le nom du fichier et le document à Convertir Markdown à PDF.
  4. Joignez le document retourné PDF aux ressources de publication GitHub.
Convertir par lots un dossier de documentation
  1. Lister tous les fichiers .md d'un dossier docs avec un module List de GitLab ou Dropbox.
  2. Parcourez la liste et téléchargez chaque fichier.
  3. Exécuter Convertir Markdown à PDF à chaque itération.
  4. Téléchargez chaque PDF vers un portail de documentation ou un lecteur partagé.
Archiver une exportation wiki sous PDF
  1. Exporter les pages wiki en tant que ZIP de Markdown fichiers provenant de Confluence ou du wiki GitLab.
  2. Cartographier le ZIP Dans le tampon, définissez le chemin d'accès au fichier Markdown et sélectionnez la page souhaitée.
  3. Exécuter Convertir Markdown à PDF pour chaque chemin de page.
  4. Stockez le résultat PDFs dans un dossier d'archive Google Drive.

Conseils pratiques

Définir le chemin du fichier Markdown uniquement pour ZIP saisir
Laissez ce champ vide si le document est un fichier .md direct. L'omettre sur un ZIP L'entrée provoque une défaillance du module car celui-ci ne trouve pas de fichier à afficher.
Utiliser une image absolue URLs
Chemins d'images relatifs dans le Markdown La source peut ne pas être résolue au moment du rendu. Pointez les références d'images vers une URL complète : https:// URL ils apparaissent donc dans le PDF.
Conservez l'extension du fichier dans le nom du fichier
Incluez l'extension .md ou .zip dans le nom du fichier afin que le module et les modules en aval reconnaissent correctement le format source.
Itérer pour plusieurs fichiers
Le module affiche un Markdown Une source par exécution. Placez un Repeater ou un Iterator en amont pour traiter un dossier entier de fichiers .md.
Des crédits sont consommés par conversion.
Chaque exécution consomme PDF4me Utilisez les crédits de votre forfait. Consultez votre tableau de bord d'utilisation avant de dimensionner une conversion par lots importante.

Aide-mémoire

ChampValeur
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)

Foire aux questions

Comment puis-je convertir Markdown à PDF dans Make?+
Ajoutez le PDF4me Convertir Markdown à PDF module à un Make Dans ce scénario, connectez-vous, associez le nom de fichier et le document d'une étape de téléchargement précédente, puis exécutez le scénario. Le module renvoie un rendu. PDF dans le champ Données du document, sans étape de conversion manuelle.
Puis-je convertir un ZIP fichier de Markdown des documents en même temps ?+
Le module convertit un Markdown un fichier par exécution, mais ce fichier peut provenir de l'intérieur d'un ZIP archive lorsque vous définissez le chemin d'accès au fichier Markdown sur le chemin relatif du fichier .md dans le ZIPPour convertir un dossier contenant des fichiers .md distincts, exécutez le module une fois par fichier dans un Make Itérateur.
Pourquoi mes images ne s'affichent-elles pas dans la version convertie ? PDF?+
Images référencées par un chemin relatif dans le Markdown La source peut ne pas se résoudre lorsque PDF est rendu. Utilisez des valeurs absolues URLs pour les images intégrées afin qu'elles se chargent correctement dans la sortie PDF. Le Guide Markdown de GitHub Couvre en détail la syntaxe des images.
Quels formats Markdown le module prend-il en charge ?+
Le module préserve le caractère GitHub Markdown éléments tels que les titres, les listes ordonnées et non ordonnées, le gras et l'italique, le code en ligne, les blocs de code délimités, les tableaux et les citations, suivant le Spécification CommonMark que GitHub Flavored Markdown étend.

Cas d'utilisation et applications industrielles

  • Documentation READMEConvertir les fichiers README en PDF pour les nouvelles versions
  • Documentation de l'APIGénérer des documents PDF à partir de Markdown
  • Journal des modificationsConvertir le fichier CHANGELOG.md au format PDF
  • Guides contributeurs: Créer des guides PDF à partir de Markdown

Actions connexes

Même tâche sur d'autres plateformes

Obtenez de l'aide