PDF-Export

Exportieren Sie Ihre Dokumentationswebsite über das Dashboard als einzelnes PDF. Jamdesk rendert jede veröffentlichte Seite in eine Datei, sendet Ihnen eine E-Mail mit einem Download-Link, sobald sie bereit ist, und stellt das PDF bis zu Ihrem nächsten Docs-Build erneut zum Download bereit.

Der PDF-Export ist nützlich für:

• Das Teilen von Dokumentation mit Prüfern, die keinen Dashboard-Zugriff haben
• Offline-Lesen im Flugzeug, in gesicherten Einrichtungen oder bei Kunden vor Ort
• Compliance- und Audit-Snapshots eines bestimmten Commits
• Pakete zur Übergabe an Kunden

Wer kann es nutzen

Der PDF-Export ist in jedem kostenpflichtigen Tarif ohne zusätzliche Kosten enthalten. Es muss kein Add-on erworben werden. Jedes Projekt kann bis zu 3 PDFs pro Tag generieren. Der Zähler wird um Mitternacht UTC zurückgesetzt.

PDF generieren

Mehrsprachige Projekte

Wenn in Ihrer docs.json mehr als eine Sprache konfiguriert ist, wird neben der Schaltfläche Generate PDF ein Dropdown-Menü für die Sprache angezeigt.

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

Jeder Export umfasst eine einzelne Sprache. Um alle drei Sprachen an einen Prüfer zu senden, wählen Sie en, exportieren Sie, wählen Sie anschließend es, exportieren Sie erneut und wiederholen Sie den Vorgang mit fr.

Caching und Regenerate

Die Settings-Seite speichert pro Projekt nur den zuletzt abgeschlossenen Export. Wenn Sie auf Regenerate klicken, prüft Jamdesk, ob der letzte Export sowohl mit dem aktuellen Build als auch mit der angeforderten Sprache übereinstimmt:

• Gleicher Build und gleiche Sprache → Das zwischengespeicherte PDF wird sofort zurückgegeben. Sie sehen einen Hinweis, dass sich seit dem letzten Export nichts geändert hat.
• Neuer Build oder andere Sprache → Ein neuer Render-Vorgang wird gestartet. Ein Klick auf Rebuild zählt als neuer Build, auch wenn der Commit unverändert ist.

Da der Cache nur einen einzigen Eintrag enthält, ersetzt der Export einer zweiten Sprache oder eines neuen Builds den bisherigen Eintrag. Das frühere PDF wird nicht gelöscht, ist aber auf der Settings-Seite nicht mehr als aktueller Export verfügbar.

So erstellen Sie nach der Aktualisierung Ihrer Dokumentation ein neues PDF:

Sie können bedenkenlos jederzeit auf Regenerate klicken. Wenn kein neuer Build abgeschlossen wurde, wird weder erneut gerendert noch eine weitere E-Mail versendet.

Ratenbegrenzung

Jedes Projekt hat zwei Limits:

• 3 abgeschlossene Exporte pro Tag. Der Zähler wird um Mitternacht UTC zurückgesetzt. Das Dashboard zeigt an, wie viele Sie bereits verwendet haben.
• 5 Minuten zwischen Exporten. Anfragen innerhalb dieses Zeitraums geben Try again in a few minutes zurück.

Cache-Treffer (gleicher Build und gleiche Sprache wie beim vorherigen Export) umgehen beide Limits. Wiederholte Downloads eines unveränderten PDFs stoßen daher nie an das Limit.

Ein PDF, dessen Generierung länger als zwanzig Minuten dauert, wird als veraltet eingestuft. Sie können erneut auf Generate PDF klicken, um die Generierung wieder in die Warteschlange einzureihen.

Was exportiert wird

Das PDF enthält jede Seite, die in der docs.json-Navigation für die ausgewählte Sprache aufgeführt ist, in der Reihenfolge ihrer Deklaration. Externe Links in der Navigation werden übersprungen. Verwaiste Seiten (Dateien in Ihrem Repository, die nicht mit der Navigation verknüpft sind) werden nicht einbezogen.

Jede Seite wird über dieselbe URL gerendert, die auch ein Leser aufrufen würde (https://<slug>.jamdesk.app/<path>). Daher erscheint im PDF alles, was im Browser angezeigt wird.

Passwortgeschützte Websites

Wenn Ihre Website passwortgeschützt ist, wird kein PDF generiert. Deaktivieren Sie den Passwortschutz für den Export und aktivieren Sie ihn anschließend wieder.

E-Mail-Zustellung

Sobald das PDF bereit ist, erhält die Person, die auf Generate PDF geklickt hat, eine E-Mail mit einem Link zurück zum Abschnitt Settings → PDF Exports sowie der Seitenanzahl, dem Zeitstempel und der Sprache (bei mehrsprachigen Projekten). Das Dashboard wechselt ebenfalls live in den Status „bereit“; Sie benötigen die E-Mail nicht zum Herunterladen.

Nur der Anforderer erhält eine E-Mail. Andere Mitwirkende sehen das neue PDF, sobald sie die Settings-Seite erneut öffnen.

Gültigkeitsdauer des Download-Links

Download-Links aus E-Mails sind ab dem Zeitpunkt, an dem die PDF-Erstellung abgeschlossen ist, 72 Stunden gültig. Das Dashboard erstellt bei jedem Öffnen der Settings-Seite eine neue URL, sodass Downloads aus dem Dashboard nicht ablaufen. Wenn ein Link aus einer E-Mail den Fehler 403 zurückgibt, öffnen Sie das Dashboard und klicken Sie dort auf Download PDF.

Fehlerbehebung

Wie geht es weiter?