Points clés
- Catégorie
- Document Tools
- Types d’entrée
- textarea, text, select, checkbox
- Type de sortie
- file
- Couverture des échantillons
- 4
- API disponible
- Yes
Vue d’ensemble
Le Visualiseur d'Extraits de Code PDF est un outil conçu pour transformer vos blocs de code en documents PDF professionnels, intégrant une mise en forme lisible, une police monospace et des liens cliquables vers votre dépôt Git.
Quand l’utiliser
- •Pour préparer des revues de code formelles à partager avec votre équipe.
- •Pour archiver des extraits de code spécifiques dans une documentation technique imprimable.
- •Pour présenter des solutions techniques lors de réunions sans dépendre d'un accès direct au dépôt.
Comment ça marche
- •Saisissez vos extraits de code au format JSON en précisant le chemin du fichier, le langage et les lignes concernées.
- •Configurez l'URL de votre dépôt et la branche cible pour activer les liens de navigation.
- •Personnalisez le rendu visuel en choisissant le format de page, l'orientation et le thème (clair ou sombre).
- •Générez et téléchargez votre fichier PDF prêt à l'emploi.
Cas d’usage
Exemples
1. Revue de code multi-fichiers
Développeur Senior- Contexte
- Besoin de présenter deux modules TypeScript distincts lors d'une revue de code hebdomadaire.
- Problème
- Extraire proprement le code tout en permettant aux relecteurs de cliquer pour voir le contexte complet sur GitHub.
- Comment l’utiliser
- Coller les deux blocs de code dans le champ JSON, définir l'URL du dépôt et choisir le thème clair.
- Configuration d’exemple
-
{"repoBaseUrl": "https://github.com/example/repo", "theme": "light", "pageSize": "A4"} - Résultat
- Un PDF propre avec deux extraits distincts, chacun possédant un lien direct vers le fichier source sur GitHub.
2. Documentation de correctif en mode paysage
Ingénieur DevOps- Contexte
- Documentation d'une classe de gestion d'outils complexe pour un wiki interne.
- Problème
- Le code est trop large pour une page portrait standard.
- Comment l’utiliser
- Activer l'option paysage et utiliser le thème sombre pour une meilleure mise en évidence de la syntaxe.
- Configuration d’exemple
-
{"landscape": true, "theme": "dark", "pageSize": "Letter"} - Résultat
- Un document PDF en mode paysage offrant une largeur suffisante pour le code et une lecture confortable grâce au thème sombre.
Tester avec des échantillons
json, pdfHubs associés
FAQ
Quels formats de page sont supportés ?
L'outil prend en charge les formats A4 et Letter.
Puis-je modifier l'apparence du code ?
Oui, vous pouvez basculer entre un thème clair et un thème sombre pour optimiser la lisibilité.
Les liens vers le dépôt sont-ils fonctionnels ?
Oui, en fournissant l'URL de base et la branche, l'outil génère des liens cliquables pointant directement vers les fichiers sources.
Est-il possible d'inclure plusieurs extraits dans un seul PDF ?
Absolument, le champ JSON accepte une liste d'objets pour compiler plusieurs extraits dans un même document.
L'outil nécessite-t-il une connexion à mon compte Git ?
Non, l'outil génère les liens statiquement à partir des paramètres fournis sans accéder à vos données privées.