Comment transformer le README d’un projet en PDF
Un README s’affiche bien sur une plateforme d’hébergement de code, mais clients, auditeurs et services achats demandent souvent la documentation du projet dans un PDF qu’ils peuvent archiver. Ce guide transforme le fichier Markdown en document soigné, sans outil de compilation.
Le PDF conserve la structure du README, donc titres, listes, tableaux et blocs de code s’affichent comme l’auteur l’a voulu.
Étape par étape
Récupérez le fichier README
Téléchargez README.md depuis le dépôt ou enregistrez-le depuis votre éditeur. Les fichiers jusqu’à 1 Mo sont acceptés.
Convertissez-le
Ouvrez README en PDF et choisissez le fichier. Il n’y a aucune option ; titres, listes, tableaux et blocs de code sont mis en page automatiquement.
Vérifiez les images
Les images qui pointent vers une adresse internet ne sont pas chargées. Si le README dépend de captures d’écran, ajoutez-les ensuite comme pages séparées.
Fusionnez-le avec d’autres documents
Ouvrez Fusionner PDF et ajoutez le PDF du README avec d’autres fichiers, comme une licence, un journal des modifications ou un schéma d’architecture.
Numérotez les pages
Ouvrez Numéroter les pages d’un PDF et choisissez un format et une position, pour que les relecteurs puissent citer des pages précises.
Outils utilisés dans ce guide
Questions sur cette tâche
- Puis-je convertir plusieurs fichiers Markdown ?
- Convertissez chaque fichier séparément, puis réunissez les résultats avec Fusionner PDF dans l’ordre voulu.
- Les badges et les images distantes s’affichent-ils ?
- Non. Les images liées depuis internet sont ignorées, donc les badges disparaissent. Le texte qui les entoure est conservé.
- Le README est-il envoyé en ligne ?
- La conversion se fait sur un serveur sécurisé qui supprime le fichier dès que le PDF est envoyé. La fusion et la numérotation fonctionnent dans votre navigateur.