Esportazione PDF

Esporta il sito di documentazione come singolo PDF dal dashboard. Jamdesk esegue il rendering di ogni pagina pubblicata in un unico file, invia via email un link per il download quando è pronto e mantiene il PDF disponibile per un nuovo download fino al successivo build della documentazione.

L'esportazione PDF è utile per:

• Condividere la documentazione con revisori che non hanno accesso al dashboard
• Leggere offline in aereo, in strutture ad alta sicurezza o presso le sedi dei clienti
• Creare snapshot per la conformità e gli audit a uno specifico commit
• Preparare pacchetti per la consegna ai clienti

Chi può usarlo

L'esportazione PDF è inclusa in ogni piano a pagamento senza costi aggiuntivi e non è disponibile alcun componente aggiuntivo da acquistare. Ogni progetto può generare fino a 3 PDF al giorno; il contatore viene reimpostato a mezzanotte UTC.

Generare un PDF

Progetti multilingue

Se docs.json contiene più di una lingua configurata, accanto al pulsante Generate PDF viene visualizzato un menu a discesa per la selezione della lingua.

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

Ogni esportazione riguarda una sola lingua. Per inviare tutte e tre le versioni a un revisore, seleziona en, esporta, quindi es, esporta e infine fr.

Caching e rigenerazione

La pagina Settings conserva solo l'esportazione completata più recente per ogni progetto. Quando fai clic su Regenerate, Jamdesk verifica se l'ultima esportazione corrisponde sia al build corrente sia alla lingua richiesta:

• Stesso build e stessa lingua → il PDF memorizzato nella cache viene restituito immediatamente. Viene visualizzato un avviso che spiega che nulla è cambiato dall'ultima esportazione.
• Nuovo build o lingua diversa → viene avviato un nuovo rendering. Fare clic su Rebuild conta come nuovo build, anche quando il commit non è cambiato.

Poiché la cache è costituita da un singolo elemento, l'esportazione di una seconda lingua o di un nuovo build sostituisce quella precedente. Il PDF precedente non viene eliminato, ma non è più quello mostrato nella pagina Settings.

Per ottenere un nuovo PDF dopo aver aggiornato la documentazione:

Puoi fare clic su Regenerate liberamente. Se non è stato completato alcun nuovo build, il sito non verrà sottoposto a nuovo rendering e non verrà inviata una nuova email.

Limitazione della frequenza

Ogni progetto ha due limiti:

• 3 esportazioni completate al giorno. Il contatore viene reimpostato a mezzanotte UTC. Il dashboard mostra quante ne hai utilizzate.
• 5 minuti tra un'esportazione e l'altra. Le richieste effettuate durante questo intervallo restituiscono Try again in a few minutes.

I riscontri dalla cache (stesso build e stessa lingua dell'esportazione precedente) non sono soggetti a nessuno dei due limiti: i download ripetuti di un PDF invariato non raggiungono mai il limite.

Un PDF la cui generazione dura più di venti minuti viene considerato obsoleto. Puoi fare nuovamente clic su Generate PDF per inserirlo di nuovo nella coda.

Cosa viene esportato

Il PDF include ogni pagina elencata nella navigazione docs.json per la lingua scelta, nell'ordine di dichiarazione. I link esterni nella navigazione vengono ignorati. Le pagine orfane, ovvero i file presenti nel repository ma non collegati alla navigazione, non vengono incluse.

Ogni pagina viene sottoposta a rendering tramite lo stesso URL che userebbe un lettore (https://<slug>.jamdesk.app/<path>), quindi tutto ciò che viene visualizzato nel browser appare anche nel PDF.

Siti protetti da password

Se il sito è protetto da password, non verrà generato alcun PDF. Disattiva la protezione con password per eseguire l'esportazione, quindi riattivala al termine.

Consegna via email

Quando il PDF è pronto, la persona che ha fatto clic su Generate PDF riceve un'email con un link alla sezione Settings → PDF Exports, oltre al numero di pagine, al timestamp e alla lingua, per i progetti multilingue. Anche il dashboard passa allo stato pronto in tempo reale: non è necessario attendere l'email per scaricare il PDF.

L'email viene inviata solo a chi ha effettuato la richiesta. Gli altri collaboratori vedranno il nuovo PDF la prossima volta che apriranno la pagina Settings.

Durata del link di download

I link per il download inclusi nelle email sono validi per 72 ore dal completamento del PDF. Il dashboard genera un nuovo URL ogni volta che apri la pagina Settings, quindi i download dal dashboard non scadono. Se un link ricevuto via email restituisce un errore 403, apri il dashboard e fai clic su Download PDF.

Risoluzione dei problemi

Cosa fare dopo?