导出 PDF
从 Jamdesk 控制台将整个文档站点导出为单个 PDF,所有付费套餐均可使用,每天最多导出 3 次。
在控制台中将文档站点导出为一个 PDF。Jamdesk 会将每个已发布页面渲染到同一个文件中。文件准备就绪后,系统会向您发送下载链接。该 PDF 可重新下载,直至下一次文档构建。
PDF 导出适用于以下场景:
- 与没有控制台访问权限的审阅者共享文档
- 在飞机上、安全设施内或客户现场离线阅读
- 在特定提交版本上生成合规性与审计快照
- 客户交付资料包
谁可以使用
PDF 导出包含在每个付费套餐中,无需额外付费,也无需购买附加组件。每个项目每天最多可生成 3 个 PDF。计数器在 UTC 午夜重置。
生成 PDF
在控制台侧边栏中选择项目,点击设置,然后滚动到项目元数据下方的 PDF 导出部分。
Jamdesk 在无头浏览器中渲染站点并将 PDF 写入存储时,按钮会变为生成中…。完成所需时间取决于页面数量及其中图像的多少。大多数站点可在几分钟内完成。
PDF 准备就绪后,我们会向您发送一封邮件,其中包含返回设置页面的链接。页面状态也会实时更新。
点击下载 PDF。如果链接过期,请参阅下载链接有效期。
多语言项目
当 docs.json 包含多种语言时,生成 PDF 按钮旁会出现语言下拉菜单。
{
"navigation": {
"languages": [
{ "language": "en", "default": true },
{ "language": "es" },
{ "language": "fr" }
]
}
}每次导出涵盖一种语言。若要向审阅者发送全部三种语言,请依次导出:en,然后 es,再 fr。
缓存与重新生成
设置页面仅记住每个项目最近一次已完成的导出。重新生成会检查上一次导出是否与当前构建以及您所请求的语言相匹配:
- 相同构建和语言 → Jamdesk 立即返回缓存的 PDF。提示会说明自上次导出以来没有任何变化。
- 新构建或不同语言 → 开始新的渲染。点击重建会被视为一次新构建,即使提交未发生变化。
缓存只保留一次导出。导出第二种语言或新构建会替换它。之前的 PDF 不会被删除,只是设置页面不再显示它。
更新文档后要获取新的 PDF:
将更改推送到 GitHub,或使用 CLI 中的 jamdesk deploy。
控制台中的构建列表会在新提交上显示已完成。
在设置页面点击重新生成。
可以频繁点击重新生成,它不会在没有新构建的情况下重新渲染或重新发送邮件。
速率限制
每个项目有两项限制:
- 每天 3 次已完成的导出:计数器在 UTC 午夜重置。控制台会显示您已使用的次数。
- 导出之间需间隔 5 分钟:在此时间窗口内发出的请求会返回
Try again in a few minutes。
缓存命中(与上次导出的构建和语言相同)不受这些限制约束。
若 PDF 生成超过二十分钟仍未完成,Jamdesk 会将其视为过期。再次点击生成 PDF 即可重新加入队列。
导出内容
PDF 包含所选语言在 docs.json 导航中列出的每个页面,并按声明顺序排列。导航中的外部链接会被跳过。孤立页面(存在于仓库中但未接入导航的文件)不会包含在内。
Jamdesk 使用读者访问的同一 URL 渲染每个页面(https://<slug>.jamdesk.app/<path>)。浏览器中显示的任何内容都会出现在 PDF 中。
受密码保护的站点
PDF 导出无法在密码保护的站点上运行。请先关闭密码保护再运行导出,导出完成后再重新启用。
电子邮件发送
点击生成 PDF的人会在 PDF 准备就绪时收到一封邮件。邮件中的链接会指向设置 → PDF 导出部分,并列出页数、时间戳以及语言(针对多语言项目)。控制台会实时切换到就绪状态。下载无需依赖邮件。
只有发起请求的人会收到邮件。其他协作者会在下次打开设置页面时看到新的 PDF。
如果导出完成后几分钟内未收到邮件,请检查垃圾邮件文件夹。无论如何,您都可以在控制台中获取该 PDF。
下载链接有效期
邮件中的下载链接自 PDF 完成之时起有效期为 72 小时。每次打开设置页面时,控制台都会生成新的 URL。控制台中的下载不会过期。如果邮件链接返回 403,请在控制台中点击下载 PDF。
故障排除
PDF 导出渲染的是已构建的站点,而非源 MDX。您至少需要在默认分支上完成一次成功构建。推送一个提交或在构建页面点击重建,待构建完成后重试。
您的项目使用的是免费试用版。请在设置 → 账单中升级。
每个项目每个 UTC 日最多完成 3 次导出。计数器在 UTC 午夜重置。
您触发了两次导出之间的五分钟间隔限制。请等待后重试。
Jamdesk 复用了缓存的 PDF。自上次导出以来没有完成新的构建。请推送一个提交,或在构建页面点击重建。构建完成后再次点击重新生成。参见缓存与重新生成。
导出器仅提取您在 docs.json 导航中、以所选语言列出的页面。孤立页面(已编写但未加入导航)和外部链接不会出现。请检查缺失的页面能否在浏览器中通过 <slug>.jamdesk.app 正常加载。
大型图表、视频和未优化的图像会迅速增大 PDF 体积。开启自动图像转换可将图像字节减少 60-80%。视频会渲染为带播放图标的封面帧,而不是完整视频。
