Les grands projets open source organisent souvent leur documentation à travers des dizaines de dossiers imbriqués. Localiser, télécharger et convertir manuellement chaque fichier Markdown en PDF prend un temps précieux. Avec md2pdf, vous pouvez inspecter l’arborescence complète d’un dépôt directement depuis votre navigateur et sélectionner précisément le contenu recherché.
Ce guide explique comment md2pdf analyse les dépôts GitHub, facilite la navigation dans les sous-dossiers et prépare vos documents techniques pour une génération PDF nette.
Fonctionnement de l’analyse d’arborescence GitHub
Lorsque vous renseignez l’URL d’un dépôt public dans md2pdf, le client interroge l’API GitHub pour obtenir la structure Git. Au lieu de télécharger l’archive intégrale du projet, md2pdf extrait uniquement les métadonnées requises pour afficher l’explorateur de fichiers.
Chaque élément est évalué selon les extensions Markdown prises en charge, telles que .md, .markdown, .mdown et .mkd. Les fichiers de code et ressources superflues sont écartés de la vue pour vous offrir un aperçu clair de la documentation disponible.
# Expected GitHub repository tree representation
docs/
├── architecture/
│ ├── overview.md
│ └── data-flow.md
├── guides/
│ ├── getting-started.md
│ └── deployment.md
└── api-reference.mdNavigation dans les dossiers imbriqués et hiérarchies de fichiers
Les architectures documentaires séparent souvent les tutoriels par domaine d’application. L’interface md2pdf propose une arborescence dépliable permettant d’examiner chaque sous-dossier sans quitter la page principale.
- Développer et réduire les dossiers : Cliquez sur le nom des répertoires pour basculer leur affichage sans perdre le fil de votre navigation.
- Chemins relatifs complets : L’explorateur indique clairement l’emplacement de chaque fichier au sein de l’arborescence du projet.
- Vérification du contenu : Assurez-vous que les guides ciblés sont bien renseignés avant d’engager la phase de rendu.
Sélection ciblée de fichiers Markdown multi-dossiers
Il n’est pas nécessaire d’exporter l’intégralité d’un dépôt. md2pdf offre une souplesse de sélection totale :
- Sélection précise : Cochez individuellement des guides dans différents répertoires pour concevoir un manuel sur mesure.
- Bascule de dossiers : Utilisez la case à cocher d’un dossier pour inclure ou exclure tous ses fichiers enfants d’un seul geste.
- Fusion multi-répertoires : Rassemblez les guides de
docs/, les tutoriels detutorials/et leREADME.mdinitial dans une même compilation.
Sécurité côté client et gestion des quotas d’API
L’ensemble des requêtes d’arborescence et des téléchargements de fichiers s’exécute localement dans le navigateur. Vos données et vos jetons personnels ne sont jamais transmis à des serveurs tiers.
Pour les requêtes anonymes, l’API publique de GitHub applique un quota de 60 appels par heure et par adresse IP. md2pdf optimise ces flux en regroupant ses requêtes d’arborescence récursive, assurant une navigation réactive même sur les dépôts d’envergure.
Conversion de votre sélection en PDF
Une fois vos fichiers sélectionnés, lancez la compilation. Vous pouvez choisir d’exporter vos documents sous forme de fichiers PDF individuels regroupés dans une archive ZIP, ou de fusionner tous les chapitres dans un livre PDF unique enrichi d’un sommaire et de numéros de page continus.
Créez votre propre PDF de README
Gratuit, sans compte et entièrement côté client.