PDF-Export
Exportieren Sie Ihre gesamte Dokumentationsseite als einzelne PDF-Datei über das Jamdesk-Dashboard. Verfügbar in allen kostenpflichtigen Tarifen, bis zu 3 Exporte pro Tag.
Exportieren Sie Ihre Dokumentationsseite als eine PDF-Datei über das Dashboard. Jamdesk rendert jede veröffentlichte Seite in eine einzige Datei. Sobald die Datei fertig ist, erhalten Sie einen Download-Link per E-Mail. Die PDF bleibt bis zum nächsten Dokumentations-Build zum erneuten Herunterladen verfügbar.
Der PDF-Export eignet sich für:
- Die Weitergabe der Dokumentation an Prüfer ohne Dashboard-Zugriff
- Offline-Lektüre im Flugzeug, in gesicherten Einrichtungen oder bei Kunden vor Ort
- Compliance- und Audit-Snapshots zu einem bestimmten Commit
- Übergabepakete für Kunden
Wer kann es nutzen
Der PDF-Export ist in jedem kostenpflichtigen Tarif ohne Aufpreis enthalten. Ein Zusatzpaket ist nicht erforderlich. Jedes Projekt kann bis zu 3 PDFs pro Tag erzeugen. Der Zähler wird um Mitternacht UTC zurückgesetzt.
PDF generieren
Wählen Sie das Projekt in der Dashboard-Seitenleiste aus, klicken Sie auf Settings und scrollen Sie zum Abschnitt PDF Exports unterhalb der Projektmetadaten.
Die Schaltfläche wechselt zu Generating…, während Jamdesk die Seite in einem Headless-Browser rendert und die PDF im Speicher ablegt. Die Dauer hängt von der Seitenanzahl und dem Bildanteil ab. Die meisten Seiten sind in wenigen Minuten fertig.
Wir senden Ihnen einen Link zurück zur Einstellungsseite, sobald die PDF fertig ist. Der Seitenstatus aktualisiert sich außerdem live.
Klicken Sie auf Download PDF. Siehe Gültigkeitsdauer des Download-Links, falls der Link einmal abläuft.
Mehrsprachige Projekte
Neben der Schaltfläche Generate PDF erscheint ein Sprachauswahlmenü, wenn docs.json mehr als eine Sprache enthält.
{
"navigation": {
"languages": [
{ "language": "en", "default": true },
{ "language": "es" },
{ "language": "fr" }
]
}
}Jeder Export umfasst eine Sprache. Exportieren Sie jede Sprache nacheinander, um alle drei an einen Prüfer zu senden: en, dann es, dann fr.
Caching und Regenerate
Die Einstellungsseite merkt sich nur den letzten abgeschlossenen Export pro Projekt. Regenerate prüft, ob der letzte Export dem aktuellen Build und der angeforderten Sprache entspricht:
- Gleicher Build und gleiche Sprache → Jamdesk gibt die zwischengespeicherte PDF sofort zurück. Ein Hinweis zeigt, dass sich seit dem letzten Export nichts geändert hat.
- Neuer Build oder andere Sprache → Ein neuer Render startet. Ein Klick auf Rebuild zählt als neuer Build, auch wenn der Commit unverändert ist.
Der Zwischenspeicher enthält genau einen Export. Ein Export einer zweiten Sprache oder eines neuen Builds ersetzt ihn. Die frühere PDF wird nicht gelöscht, die Einstellungsseite zeigt sie jedoch nicht mehr an.
So erhalten Sie nach einer Aktualisierung Ihrer Dokumentation eine frische PDF:
Pushen Sie Ihre Änderungen zu GitHub oder verwenden Sie jamdesk deploy über die CLI.
Die Build-Liste im Dashboard zeigt Completed für den neuen Commit.
Klicken Sie auf der Einstellungsseite auf Regenerate.
Regenerate kann bedenkenlos oft angeklickt werden. Ohne neuen Build wird weder neu gerendert noch erneut eine E-Mail versandt.
Ratenbegrenzung
Jedes Projekt hat zwei Grenzen:
- 3 abgeschlossene Exporte pro Tag: Der Zähler wird um Mitternacht UTC zurückgesetzt. Das Dashboard zeigt, wie viele Sie bereits genutzt haben.
- 5 Minuten zwischen Exporten: Anfragen innerhalb dieses Zeitfensters liefern
Try again in a few minutes.
Cache-Treffer (gleicher Build und gleiche Sprache wie beim vorherigen Export) umgehen diese Grenzen.
Jamdesk betrachtet eine PDF, die nach zwanzig Minuten noch erzeugt wird, als veraltet. Klicken Sie erneut auf Generate PDF, um sie erneut einzureihen.
Was exportiert wird
Die PDF enthält alle Seiten aus der Navigation Ihrer docs.json für die gewählte Sprache, in der deklarierten Reihenfolge. Externe Links in der Navigation werden übersprungen. Verwaiste Seiten (Dateien in Ihrem Repository, die nicht in der Navigation eingebunden sind) werden nicht aufgenommen.
Jamdesk rendert jede Seite über dieselbe URL, die ein Leser aufruft (https://<slug>.jamdesk.app/<path>). Alles, was im Browser sichtbar ist, erscheint auch in der PDF.
Passwortgeschützte Websites
Der PDF-Export funktioniert nicht bei einer passwortgeschützten Seite. Deaktivieren Sie den Passwortschutz für den Export und aktivieren Sie ihn danach wieder.
E-Mail-Zustellung
Die Person, die auf Generate PDF geklickt hat, erhält eine E-Mail, sobald die PDF fertig ist. Sie verlinkt zurück zum Abschnitt Einstellungen → PDF-Exporte und nennt außerdem die Seitenanzahl, den Zeitstempel und die Sprache (bei mehrsprachigen Projekten). Das Dashboard wechselt live in den Status „bereit“. Zum Herunterladen brauchen Sie die E-Mail nicht.
Nur die anfragende Person erhält eine E-Mail. Andere Mitarbeitende sehen die neue PDF beim nächsten Öffnen der Einstellungsseite.
Falls die E-Mail wenige Minuten nach Abschluss nicht eintrifft, prüfen Sie Ihren Spam-Ordner. Die PDF ist in jedem Fall über das Dashboard abrufbar.
Gültigkeitsdauer des Download-Links
Download-Links in E-Mails sind 72 Stunden ab dem Abschluss der PDF gültig. Das Dashboard erzeugt bei jedem Öffnen der Einstellungsseite eine neue URL. Downloads über das Dashboard laufen nicht ab. Liefert ein E-Mail-Link den Status 403, klicken Sie im Dashboard auf Download PDF.
Fehlerbehebung
Der PDF-Export rendert eine gebaute Seite, nicht Ihre MDX-Quelldatei. Sie benötigen mindestens einen erfolgreichen Build auf Ihrem Standardbranch. Pushen Sie einen Commit oder klicken Sie auf der Builds-Seite auf Rebuild. Versuchen Sie es nach Abschluss des Builds erneut.
Ihr Projekt läuft im kostenlosen Testzeitraum. Upgraden Sie unter Einstellungen → Abrechnung.
Jedes Projekt ist auf 3 abgeschlossene Exporte pro UTC-Tag begrenzt. Der Zähler wird um Mitternacht UTC zurückgesetzt.
Sie haben den Fünf-Minuten-Abstand zwischen Exporten unterschritten. Warten Sie und versuchen Sie es erneut.
Jamdesk hat die zwischengespeicherte PDF wiederverwendet. Seit dem letzten Export ist kein neuer Build abgeschlossen worden. Pushen Sie einen Commit oder klicken Sie auf der Builds-Seite auf Rebuild. Klicken Sie nach Abschluss des Builds erneut auf Regenerate. Siehe Zwischenspeicherung und Regenerate.
Der Exporter berücksichtigt nur Seiten aus der Navigation Ihrer docs.json in der gewählten Sprache. Verwaiste Seiten (erstellt, aber nicht in die Navigation eingebunden) und externe Links erscheinen nicht. Prüfen Sie, ob die fehlenden Seiten im Browser unter <slug>.jamdesk.app sauber laden.
Große Diagramme, Videos und unoptimierte Bilder vergrößern die PDF-Datei schnell. Aktivieren Sie die automatische Bildkonvertierung, um die Bildgröße um 60–80 % zu reduzieren. Videos werden als Vorschaubild mit Play-Symbol gerendert, nicht als vollständiges Video.