Jamdesk Documentation logo

Export PDF

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

Exportez votre site de documentation sous forme d'un seul PDF depuis le dashboard. Jamdesk génère chaque page publiée dans 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'à votre prochain build de documentation.

Télécharger un exemple de PDF

Découvrez à quoi ressemble un vrai export. Le site de documentation complet de Jamdesk, généré via ce même pipeline. 408 pages, 6,6 Mo.

L'export PDF est utile pour :

  • Partager la documentation avec des réviseurs qui n'ont pas accès au dashboard
  • La lecture hors ligne dans les avions, les installations sécurisées ou chez les clients
  • Les instantanés de conformité et d'audit à un commit spécifique
  • Les packages de transfert client

Qui peut l'utiliser

L'export PDF est disponible sur tous les plans payants. Aucun module complémentaire, aucun frais supplémentaire. Les projets en essai gratuit voient le bouton mais ne peuvent pas lancer un export avant de passer à un plan supérieur.

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 le PDF

Le bouton se transforme en Génération en cours… pendant que Jamdesk génère le site dans un navigateur headless et écrit le PDF dans le stockage. Le temps d'exécution dépend 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 temps réel.

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 paramètres régionaux apparaît à côté du bouton Générer le PDF.

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

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

La langue par défaut est exportée aux URL racines de votre site (par ex. <slug>.jamdesk.app/getting-started, ou votre domaine personnalisé). Les autres paramètres régionaux sont exportés à leurs URL préfixées (par ex. /es/getting-started).

Mise en cache et Régénération

La page Paramètres mémorise uniquement l'export complété le plus récent par projet. Lorsque vous cliquez sur Régénérer, Jamdesk vérifie si le dernier export correspond à la fois au build actuel et aux paramètres régionaux demandés :

  • Même build et mêmes paramètres régionaux → le PDF en cache est renvoyé immédiatement. Un message vous indique que rien n'a changé depuis votre dernier export.
  • Nouveau build ou paramètres régionaux différents → un nouveau rendu est lancé. Cliquer sur Rebuild compte comme un nouveau build, même si le commit est inchangé.

Comme le cache ne dispose que d'un seul emplacement, l'export d'un deuxième paramètre régional ou d'un nouveau build remplace ce qui s'y trouvait auparavant. 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

Envoyez vos modifications sur 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

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

La régénération peut être cliquée sans retenue. Si aucun nouveau build n'est terminé, elle ne relancera pas le rendu ni l'envoi d'e-mail.

Limitation du débit

Vous pouvez produire un export complété par projet toutes les cinq minutes. Les requêtes dans cette fenêtre renvoient Réessayez dans quelques minutes. Le chemin de cache ne tient pas compte de la limitation du débit, donc les téléchargements répétés d'un PDF inchangé n'atteignent jamais la limite.

Un PDF en cours de génération depuis plus de vingt minutes est considéré comme obsolète. Vous pouvez cliquer à nouveau sur Générer le 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 dans votre dépôt qui ne sont pas intégrés à la navigation) ne sont pas incluses.

Chaque page est générée via la même URL qu'un lecteur utiliserait (https://<slug>.jamdesk.app/<path>), donc tout ce qui s'affiche dans le navigateur apparaît dans le PDF. Jusqu'à 10 % des pages peuvent échouer au rendu ; au-delà de ce seuil, l'export est interrompu et vous pouvez réessayer.

Sites protégés par mot de passe

Si votre site est protégé par un mot de passe, l'exporteur PDF ne peut pas le déverrouiller. Le navigateur headless effectuant le rendu ne porte pas de session. Les pages protégées n'apparaîtront pas dans le PDF et comptent dans le budget d'échec de 10 % décrit ci-dessus. Si la majeure partie de votre site est verrouillée, désactivez la protection par mot de passe avant d'exécuter l'export, ou n'utilisez que les pages non protégées.

Envoi par e-mail

Lorsque le PDF est prêt, la personne qui a cliqué sur Générer le 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 les paramètres régionaux (pour les projets multilingues). Le dashboard lui-même passe également à l'état prêt en temps réel ; vous n'avez pas besoin de l'e-mail pour télécharger.

Seul le demandeur reçoit un 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 de la génération, vérifiez votre dossier spam. Le PDF est toujours disponible depuis le dashboard, que l'e-mail soit reçu ou non.

Durée de vie du lien de téléchargement

L'URL de téléchargement dans le dashboard et dans l'e-mail est une URL signée à courte durée de vie. Si elle renvoie une erreur 403, rechargez la page Paramètres. Jamdesk génère une nouvelle URL à chaque fois que la page interroge le statut de l'export.

Dépannage

La fonctionnalité est temporairement désactivée sur toute la plateforme. Contactez le support.

L'export PDF génère un site construit, pas votre MDX source. Vous avez besoin d'au moins un build réussi sur votre branche par défaut. Envoyez un commit ou cliquez sur Rebuild sur la page Builds, attendez qu'il se termine, puis réessayez.

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

Vous avez atteint la limitation du débit de cinq minutes. Attendez et réessayez.

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

L'exporteur ne récupère que les pages présentes 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), les liens externes et les pages protégées par mot de passe n'apparaîtront pas. Les échecs de rendu individuels sont consignés dans l'export. Si l'export entier échoue avec Trop de pages n'ont pas pu être générées, vérifiez que les pages affectées se chargent correctement dans un navigateur à l'adresse <slug>.jamdesk.app.

Les grands diagrammes, les vidéos et les images non optimisées font rapidement gonfler la taille du PDF. Activez la Conversion automatique des images pour réduire le poids des images de 60 à 80 %. Les vidéos sont rendues sous forme d'une image d'aperçu avec une icône de lecture, elles ne gonflent donc pas le fichier.

Et ensuite ?

Déclencher des Builds

L'export PDF s'exécute sur le build complété le plus récent. Lancez-en un manuellement ou sur push.

Optimisation des images

Convertissez PNG/JPG en WebP au moment du build pour maintenir les PDF à une taille réduite.