Exportação de PDF

Exporte seu site de documentação como um único PDF pelo dashboard. O Jamdesk renderiza cada página publicada em um arquivo, envia por e-mail um link de download quando ele fica pronto e mantém o PDF disponível para baixar novamente até a próxima build da documentação.

A exportação de PDF é útil para:

• Compartilhar a documentação com revisores que não têm acesso ao dashboard
• Ler offline em aviões, instalações seguras ou nas dependências de clientes
• Criar snapshots de conformidade e auditoria em um commit específico
• Preparar pacotes de entrega para clientes

Quem pode usar

A exportação de PDF está incluída em todos os planos pagos, sem custo adicional, e não há nenhum complemento para comprar. Cada projeto pode gerar até 3 PDFs por dia, com o contador sendo redefinido à meia-noite UTC.

Gerar um PDF

Projetos multilíngues

Se o seu docs.json tiver mais de um idioma configurado, um menu suspenso de localidade aparecerá ao lado do botão Generate PDF.

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

Cada exportação abrange um único idioma. Para enviar os três idiomas a um revisor, selecione en, exporte, depois es, exporte e, por fim, fr.

Cache e regeneração

A página Settings armazena apenas a exportação concluída mais recente de cada projeto. Quando você clica em Regenerate, o Jamdesk verifica se a última exportação corresponde à build atual e à localidade solicitada:

• Mesma build e localidade → o PDF em cache é entregue imediatamente. Você verá um aviso explicando que nada mudou desde a última exportação.
• Nova build ou localidade diferente → uma nova renderização é iniciada. Clicar em Rebuild conta como uma nova build, mesmo quando o commit não foi alterado.

Como o cache ocupa um único espaço, exportar uma segunda localidade ou uma nova build substitui o conteúdo anterior. O PDF anterior não é excluído, mas deixa de ser o PDF exibido na página Settings.

Para obter um PDF atualizado depois de alterar sua documentação:

É seguro clicar em Regenerate sempre que necessário. Se nenhuma nova build tiver sido concluída, o Jamdesk não fará uma nova renderização nem enviará outro e-mail.

Limitação de taxa

Cada projeto tem dois limites:

• 3 exportações concluídas por dia. O contador é redefinido à meia-noite UTC. O dashboard mostra quantas você já usou.
• 5 minutos entre exportações. As requisições dentro desse intervalo retornam Try again in a few minutes.

Acessos ao cache (mesma build e localidade da exportação anterior) ignoram ambos os limites. Assim, downloads repetidos de um PDF inalterado nunca atingem o limite.

Um PDF que estiver sendo gerado há mais de vinte minutos será considerado obsoleto. Você pode clicar novamente em Generate PDF para colocá-lo na fila.

O que é exportado

O PDF inclui todas as páginas listadas na navegação do docs.json para o idioma escolhido, na ordem de declaração. Links externos na navegação são ignorados. Páginas órfãs (arquivos no seu repositório que não estão vinculados à navegação) não são incluídas.

Cada página é renderizada pela mesma URL que um leitor acessaria (https://<slug>.jamdesk.app/<path>), portanto tudo que aparece no navegador também aparece no PDF.

Sites protegidos por senha

Se o seu site estiver protegido por senha, um PDF não será gerado. Desative a proteção por senha para executar a exportação e reative-a depois.

Entrega por e-mail

Quando o PDF estiver pronto, a pessoa que clicou em Generate PDF receberá um e-mail com um link de volta para a seção Settings → PDF Exports, além da contagem de páginas, do horário e da localidade (em projetos multilíngues). O dashboard também muda para o estado de pronto em tempo real; não é necessário usar o e-mail para baixar o arquivo.

Somente a pessoa que solicitou a exportação recebe o e-mail. Os demais colaboradores verão o novo PDF na próxima vez que abrirem a página Settings.

Validade do link de download

Os links de download enviados por e-mail são válidos por 72 horas a partir do momento em que o PDF é concluído. O dashboard gera uma nova URL sempre que você abre a página Settings, portanto os downloads feitos pelo dashboard não expiram. Se um link de e-mail retornar 403, acesse o dashboard e clique em Download PDF.

Solução de problemas

Próximos passos?