Jamdesk Documentation logo

Export PDF

Exportez l'intégralité de votre site de documentation en un seul PDF. Téléchargeable depuis le dashboard et livré par e-mail. Plans payants uniquement.

Exportez votre site de documentation en un seul PDF depuis le dashboard. Jamdesk compile chaque page publiée en un seul fichier, vous envoie un lien de téléchargement par e-mail lorsqu'il est prêt, et conserve le PDF disponible pour un nouveau téléchargement jusqu'au prochain build.

Télécharger un exemple de PDF

Découvrez à quoi ressemble un vrai export. La documentation complète de Jamdesk, générée via ce même pipeline. 408 pages, 6.6 Mo.

L'export PDF est utile pour :

  • Partager la documentation avec des relecteurs n'ayant pas accès au dashboard
  • La lecture hors ligne dans un avion, dans des installations sécurisées ou chez des clients
  • Les instantanés de conformité et d'audit à un commit précis
  • Les paquets de remise client

Qui peut l'utiliser

L'export PDF est disponible sur chaque plan payant. Aucun module complémentaire, aucun frais supplémentaire. Chaque projet peut générer jusqu'à 3 PDF par jour, le compteur se réinitialisant à minuit UTC.

Générer un PDF

1
Ouvrir Paramètres → Exports PDF

Dans le dashboard, sélectionnez le projet dans la barre latérale, cliquez sur Paramètres et faites défiler jusqu'à la section Exports PDF sous les métadonnées du projet.

2
Cliquer sur Générer un PDF

Le bouton passe à Génération en cours… pendant que Jamdesk affiche le site dans un navigateur headless et écrit le PDF dans le stockage. Le temps de traitement évolue en fonction du nombre de pages et de la quantité d'images qu'elles contiennent. La plupart des sites se terminent en quelques minutes.

3
Attendre l'e-mail

Lorsque le PDF est prêt, nous envoyons un e-mail à l'utilisateur connecté avec un lien vers la page Paramètres. Vous pouvez également laisser la page ouverte ; le statut se met à jour en direct.

4
Télécharger

Cliquez sur Télécharger le PDF. Consultez Durée de vie du lien de téléchargement si le lien expire.

Projets multilingues

Si votre docs.json comporte plusieurs langues configurées, un menu déroulant de sélection de langue apparaît à côté du bouton Générer un PDF.

docs.json
{
  "navigation": {
    "languages": [
      { "language": "en", "default": true },
      { "language": "es" },
      { "language": "fr" }
    ]
  }
}

Chaque export couvre une seule langue. Pour envoyer les trois à un relecteur, choisissez en, exportez, puis es, exportez, puis fr.

Mise en cache et Regenerer

La page Paramètres ne conserve que le dernier export terminé par projet. Lorsque vous cliquez sur Régénérer, Jamdesk vérifie si le dernier export correspond à la fois au build actuel et à la langue demandée :

  • Même build et même langue → le PDF en cache est renvoyé immédiatement. Vous verrez un avis expliquant que rien n'a changé depuis votre dernier export.
  • Nouveau build ou langue différente → un nouveau rendu est lancé. Cliquer sur Reconstruire compte comme un nouveau build, même si le commit est inchangé.

Le cache n'étant qu'un seul emplacement, exporter une deuxième langue ou un nouveau build remplace ce qui s'y trouvait. Le PDF précédent n'est pas supprimé, mais il n'est plus celui affiché sur la page Paramètres.

Pour obtenir un PDF actualisé après avoir mis à jour votre documentation :

1
Publier le nouveau contenu

Poussez vos modifications vers GitHub, ou utilisez jamdesk deploy depuis la CLI.

2
Attendre la fin du build

La liste des Builds dans le dashboard affiche Terminé sur le nouveau commit.

3
Régénérer

Retournez sur la page Paramètres et cliquez sur Régénérer. Un nouveau build s'étant terminé depuis l'export en cache, Jamdesk lance un nouveau rendu.

Régénérer peut être cliqué librement sans risque. Si aucun nouveau build n'a été terminé, aucun nouveau rendu ni e-mail ne sera déclenché.

Limitation du débit

Chaque projet a deux limites :

  • 3 exports terminés par jour. Le compteur se réinitialise à minuit UTC. Le dashboard affiche combien vous en avez utilisés.
  • 5 minutes entre les exports. Les requêtes dans cette fenêtre renvoient Try again in a few minutes.

Les accès au cache (même build et même langue que l'export précédent) contournent ces deux limites, de sorte que les téléchargements répétés d'un PDF inchangé ne se heurtent jamais à la limite.

Un PDF dont la génération dure plus de vingt minutes est considéré comme périmé. Vous pouvez cliquer à nouveau sur Générer un PDF pour le remettre en file d'attente.

Ce qui est exporté

Le PDF inclut chaque page répertoriée dans la navigation de votre docs.json pour la langue choisie, dans l'ordre de déclaration. Les liens externes dans la navigation sont ignorés. Les pages orphelines (fichiers de votre dépôt non reliés à la navigation) ne sont pas incluses.

Chaque page est affichée via la même URL qu'un lecteur visiterait (https://<slug>.jamdesk.app/<path>), de sorte que tout ce qui s'affiche dans le navigateur apparaît dans le PDF.

Sites protégés par mot de passe

Si votre site est protégé par mot de passe, aucun PDF ne sera généré. Désactivez la protection par mot de passe pour lancer l'export, puis réactivez-la ensuite.

Livraison par e-mail

Lorsque le PDF est prêt, la personne ayant cliqué sur Générer un PDF reçoit un e-mail avec un lien vers la section Paramètres → Exports PDF, ainsi que le nombre de pages, l'horodatage et la langue (pour les projets multilingues). Le dashboard lui-même bascule aussi en temps réel vers l'état prêt ; vous n'avez pas besoin de l'e-mail pour télécharger.

Seul le demandeur reçoit l'e-mail. Les autres collaborateurs voient le nouveau PDF la prochaine fois qu'ils ouvrent la page Paramètres.

Si l'e-mail n'arrive pas dans les quelques minutes suivant la fin du traitement, vérifiez votre dossier spam. Le PDF reste disponible depuis le dashboard, que l'e-mail arrive ou non.

Duree de vie du lien de telechargement

Les liens de téléchargement par e-mail sont valides 72 heures à compter de la fin de génération du PDF. Le dashboard génère une nouvelle URL à chaque ouverture de la page Paramètres, de sorte que les téléchargements depuis le dashboard n'expirent pas. Si un lien e-mail renvoie une erreur 403, rendez-vous sur le dashboard et cliquez sur Télécharger le PDF.

Dépannage

L'export PDF affiche un site compilé, pas votre MDX source. Vous avez besoin d'au moins un build réussi sur votre branche par défaut. Poussez un commit ou cliquez sur Reconstruire sur la page Builds, attendez la fin, puis réessayez.

Votre projet est en période d'essai gratuit. Passez à un plan supérieur depuis Paramètres → Facturation.

Chaque projet est limité à 3 exports terminés par jour UTC. Le compteur se réinitialise à minuit UTC.

Vous avez atteint l'intervalle minimum de cinq minutes entre les exports. Attendez et réessayez.

Le PDF en cache a été réutilisé car aucun nouveau build n'a été terminé depuis le dernier export. Poussez un commit, ou cliquez sur Reconstruire sur la page Builds, puis réessayez Régénérer une fois le build terminé. Voir Mise en cache et Regenerer.

L'exportateur ne récupère que les pages figurant dans la navigation de votre docs.json, dans la langue sélectionnée. Les pages orphelines (rédigées mais non référencées dans la navigation) et les liens externes n'apparaîtront pas. Vérifiez que les pages manquantes se chargent correctement dans un navigateur à l'adresse <slug>.jamdesk.app.

Les grands diagrammes, les vidéos et les images non optimisées gonflent rapidement la taille du PDF. Activez la Conversion automatique des images pour réduire le poids des images de 60-80 %. Les vidéos sont affichées comme une image de prévisualisation avec une icône de lecture, elles ne surchargent donc pas le fichier.

Et ensuite ?

Déclencher des builds

L'export PDF s'exécute sur le dernier build terminé. Lancez-en un manuellement ou lors d'un push.

Optimisation des images

Convertissez les PNG/JPG en WebP au moment du build pour garder les PDF légers.