Jamdesk Documentation logo

Esportazione PDF

Esporta l'intero sito della documentazione come singolo PDF dalla dashboard Jamdesk, disponibile su ogni piano a pagamento con fino a 3 esportazioni al giorno.

Esporta il sito della documentazione come un unico PDF dalla dashboard. Jamdesk genera in un solo file tutte le pagine pubblicate. Quando il file è pronto, ti invia via email un link per il download. Il PDF resta disponibile per essere scaricato di nuovo fino alla successiva build della documentazione.

Scarica un PDF di esempio

L'intero sito della documentazione Jamdesk, generato tramite questa pipeline. 408 pagine, 6,6 MB.

L'esportazione in PDF è utile per:

  • Condividere la documentazione con revisori che non hanno accesso alla dashboard
  • La lettura offline su aerei, in strutture riservate o presso i siti dei clienti
  • Snapshot per conformità e audit a un commit specifico
  • Pacchetti di consegna ai clienti

Chi può usarlo

L'esportazione in PDF è inclusa in ogni piano a pagamento senza costi aggiuntivi. Non c'è alcun add-on da acquistare. Ogni progetto può generare fino a 3 PDF al giorno. Il contatore si azzera a mezzanotte UTC.

Generare un PDF

1
Apri Impostazioni → Esportazioni PDF

Seleziona il progetto nella barra laterale della dashboard, fai clic su Impostazioni e scorri fino alla sezione Esportazioni PDF sotto i metadati del progetto.

2
Fai clic su Genera PDF

Il pulsante cambia in Generazione… mentre Jamdesk esegue il rendering del sito in un browser headless e scrive il PDF nello storage. Il tempo di completamento dipende dal numero di pagine e dalla quantità di immagini presenti. La maggior parte dei siti viene completata in pochi minuti.

3
Attendi l'email

Ti inviamo via email un link alla pagina Impostazioni quando il PDF è pronto. Anche lo stato della pagina si aggiorna in tempo reale.

4
Scarica

Fai clic su Scarica PDF. Consulta Durata del link di download se il link dovesse scadere.

Progetti multilingue

Accanto al pulsante Genera PDF compare un menu a tendina delle lingue quando docs.json contiene più di una lingua.

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

Ogni esportazione copre una sola lingua. Esporta ciascuna lingua in sequenza per inviare tutte e tre a un revisore: en, poi es, poi fr.

Caching e rigenerazione

La pagina Impostazioni ricorda solo l'esportazione completata più recente per progetto. Rigenera verifica se l'ultima esportazione corrisponde alla build attuale e alla lingua richiesta:

  • Stessa build e stessa lingua → Jamdesk restituisce immediatamente il PDF dalla cache. Un avviso indica che non ci sono modifiche dall'ultima esportazione.
  • Nuova build o lingua diversa → viene avviato un nuovo rendering. Fare clic su Ricostruisci conta come nuova build, anche se il commit non è cambiato.

La cache contiene una sola esportazione. Esportare una seconda lingua o una nuova build la sostituisce. Il PDF precedente non viene eliminato, ma non è più mostrato nella pagina Impostazioni.

Per ottenere un PDF aggiornato dopo aver modificato la documentazione:

1
Pubblica i nuovi contenuti

Invia le modifiche a GitHub oppure usa jamdesk deploy dalla CLI.

2
Attendi il completamento della build

L'elenco delle Build nella dashboard mostra Completata sul nuovo commit.

3
Rigenera

Fai clic su Rigenera nella pagina Impostazioni.

Rigenera può essere cliccato spesso senza problemi. Non esegue nuovamente il rendering né reinvia email senza una nuova build.

Limitazione della frequenza

Ogni progetto ha due limiti:

  • 3 esportazioni completate al giorno: il contatore si azzera a mezzanotte UTC. La dashboard mostra quante ne hai già usate.
  • 5 minuti tra un'esportazione e l'altra: le richieste effettuate entro questo intervallo restituiscono Riprova tra qualche minuto.

Le risposte dalla cache (stessa build e stessa lingua dell'esportazione precedente) non vengono conteggiate in questi limiti.

Jamdesk considera obsoleto un PDF che è ancora in generazione dopo venti minuti. Fai clic di nuovo su Genera PDF per rimetterlo in coda.

Cosa viene esportato

Il PDF include tutte le pagine elencate nella navigazione di docs.json per la lingua scelta, nell'ordine di dichiarazione. I link esterni nella navigazione vengono ignorati. Le pagine orfane (file presenti nel repository ma non collegati alla navigazione) non vengono incluse.

Jamdesk esegue il rendering di ogni pagina dallo stesso URL che visita un lettore (https://<slug>.jamdesk.app/<path>). Tutto ciò che appare nel browser appare anche nel PDF.

Siti protetti da password

L'esportazione in PDF non funziona su un sito protetto da password. Disattiva la protezione con password per eseguire l'esportazione. Riattivala successivamente.

Consegna via email

La persona che ha fatto clic su Genera PDF riceve un'email quando il PDF è pronto. L'email contiene un link alla sezione Impostazioni → Esportazioni PDF e riporta il numero di pagine, la data e l'ora e la lingua (per i progetti multilingua). La dashboard passa in tempo reale allo stato pronto. Per scaricare il file non è necessaria l'email.

Solo chi ha richiesto l'esportazione riceve l'email. Gli altri collaboratori vedono il nuovo PDF la volta successiva in cui aprono la pagina Impostazioni.

Se l'email non arriva entro pochi minuti dal completamento, controlla la cartella dello spam. In ogni caso, il PDF è disponibile dalla dashboard.

I link di download inviati via email sono validi per 72 ore dal momento in cui il PDF è completato. La dashboard crea un nuovo URL ogni volta che apri la pagina Impostazioni. I download dalla dashboard non scadono. Se un link dell'email restituisce 403, fai clic su Scarica PDF nella dashboard.

Risoluzione dei problemi

L'esportazione in PDF esegue il rendering di un sito già compilato, non del tuo MDX sorgente. Ti serve almeno una build riuscita sul branch predefinito. Invia un commit oppure fai clic su Ricostruisci nella pagina Build. Riprova dopo il completamento della build.

Il tuo progetto è nella prova gratuita. Passa a un piano a pagamento da Impostazioni → Fatturazione.

Ogni progetto è limitato a 3 esportazioni completate per giorno UTC. Il contatore si azzera a mezzanotte UTC.

Hai raggiunto l'intervallo di cinque minuti tra un'esportazione e l'altra. Attendi e riprova.

Jamdesk ha riutilizzato il PDF dalla cache. Dall'ultima esportazione non è stata completata alcuna nuova build. Invia un commit oppure fai clic su Ricostruisci nella pagina Build. Fai di nuovo clic su Rigenera dopo il completamento della build. Consulta Cache e Rigenera.

L'esportazione include solo le pagine presenti nella navigazione di docs.json, nella lingua selezionata. Le pagine orfane (scritte ma non collegate alla navigazione) e i link esterni non compaiono. Verifica che le pagine mancanti si carichino correttamente in un browser all'indirizzo <slug>.jamdesk.app.

Diagrammi grandi, video e immagini non ottimizzate aumentano rapidamente le dimensioni del PDF. Attiva la Conversione automatica delle immagini per ridurre i byte delle immagini del 60-80%. I video vengono visualizzati come fotogramma di anteprima con un'icona di riproduzione, non come video completo.

Cosa fare dopo?

Avviare le build

L'esportazione in PDF usa la build completata più recente. Avviala manualmente oppure a ogni push.

Ottimizzazione delle immagini

Converti PNG/JPG in WebP durante la build per mantenere ridotte le dimensioni dei PDF.