Jamdesk Documentation logo

Exportação em PDF

Exporte todo o seu site de documentação como um único PDF pelo painel do Jamdesk, disponível em todos os planos pagos com até 3 exportações por dia.

Exporte o seu site de documentação como um único PDF pelo painel. O Jamdesk renderiza todas as páginas publicadas em um só arquivo. Ele envia por e-mail um link para download quando o arquivo estiver pronto. O PDF continua disponível para novo download até o próximo build da documentação.

Baixar um PDF de exemplo

O site completo da documentação do Jamdesk, renderizado por este pipeline. 408 páginas, 6,6 MB.

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

  • Compartilhar a documentação com revisores que não têm acesso ao painel
  • Leitura offline em voos, em instalações seguras ou em sites de clientes
  • Capturas de conformidade e auditoria em um commit específico
  • Pacotes de entrega para clientes

Quem pode usar

A exportação em PDF está incluída em todos os planos pagos, sem custo extra. Não há complemento a comprar. Cada projeto pode gerar até 3 PDFs por dia. O contador é zerado à meia-noite UTC.

Gerar um PDF

1
Abra Configurações → Exportações em PDF

Selecione o projeto na barra lateral do painel, clique em Settings e role até a seção PDF Exports abaixo dos metadados do projeto.

2
Clique em Generate PDF

O botão muda para Generating… enquanto o Jamdesk renderiza o site em um navegador headless e grava o PDF no armazenamento. O tempo para concluir depende do número de páginas e da quantidade de imagens. A maioria dos sites termina em poucos minutos.

3
Aguarde o e-mail

Enviamos por e-mail um link de volta para a página de Settings quando o PDF estiver pronto. O status da página também é atualizado em tempo real.

4
Baixe

Clique em Download PDF. Veja Validade do link de download caso o link expire.

Projetos multilíngues

Um menu suspenso de idiomas aparece ao lado do botão Generate PDF quando o docs.json tem mais de um idioma.

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

Cada exportação cobre um idioma. Exporte cada idioma em sequência para enviar os três a um revisor: en, depois es, depois fr.

Cache e regeneração

A página de Settings guarda apenas a exportação mais recente concluída por projeto. Regenerate verifica se a última exportação corresponde ao build atual e ao idioma solicitado:

  • Mesmo build e mesmo idioma → o Jamdesk retorna imediatamente o PDF em cache. Um aviso informa que nada mudou desde a sua última exportação.
  • Novo build ou idioma diferente → uma nova renderização é iniciada. Clicar em Rebuild conta como um novo build, mesmo que o commit não tenha mudado.

O cache guarda uma única exportação. Exportar um segundo idioma ou um novo build a substitui. O PDF anterior não é excluído, mas a página de Settings não o exibe mais.

Para obter um PDF atualizado após alterar sua documentação:

1
Envie o novo conteúdo

Faça push das alterações para o GitHub ou use jamdesk deploy pela CLI.

2
Aguarde o build terminar

A lista de Builds no painel mostra Completed no novo commit.

3
Regenere

Clique em Regenerate na página de Settings.

Regenerate pode ser clicado com frequência sem problemas. Ele não renderiza nem envia e-mail novamente sem um novo build.

Limitação de taxa

Cada projeto tem dois limites:

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

Acertos de cache (mesmo build e idioma da exportação anterior) não consomem esses limites.

O Jamdesk considera um PDF ainda em geração após vinte minutos como obsoleto. Clique em Generate PDF novamente para reenfileirar.

O que é exportado

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

O Jamdesk renderiza cada página a partir da mesma URL que um leitor acessa (https://<slug>.jamdesk.app/<path>). Tudo o que aparece no navegador aparece no PDF.

Sites protegidos por senha

A exportação em PDF não funciona em um site protegido por senha. Desative a proteção por senha para executar a exportação. Reative-a depois.

Entrega por e-mail

A pessoa que clicou em Generate PDF recebe um e-mail quando o PDF estiver pronto. O e-mail traz um link para a seção Settings → PDF Exports. Ele também informa o número de páginas, o horário e o idioma (para projetos multilíngues). O painel muda para o estado pronto em tempo real. Você não precisa do e-mail para baixar.

Somente quem solicitou recebe o e-mail. Outros colaboradores veem o novo PDF na próxima vez que abrirem a página de Settings.

Se o e-mail não chegar em alguns minutos após a conclusão, verifique a pasta de spam. O PDF está disponível no painel de qualquer forma.

Os links de download enviados por e-mail são válidos por 72 horas a partir do momento em que o PDF termina. O painel cria uma nova URL sempre que você abre a página de Settings. Downloads feitos pelo painel não expiram. Se um link do e-mail retornar 403, clique em Download PDF no painel.

Solução de problemas

A exportação em PDF renderiza um site já construído, não o seu MDX de origem. Você precisa de pelo menos um build bem-sucedido na branch padrão. Faça push de um commit ou clique em Rebuild na página de Builds. Tente novamente após o build terminar.

Seu projeto está no período de teste gratuito. Faça upgrade em Settings → Billing.

Cada projeto tem o limite de 3 exportações concluídas por dia UTC. O contador é zerado à meia-noite UTC.

Você atingiu o intervalo de cinco minutos entre exportações. Aguarde e tente novamente.

O Jamdesk reutilizou o PDF em cache. Nenhum novo build foi concluído desde a última exportação. Faça push de um commit ou clique em Rebuild na página de Builds. Clique em Regenerate novamente após o build terminar. Veja Cache e Regenerate.

O exportador inclui apenas as páginas listadas na navegação do seu docs.json, no idioma selecionado. Páginas órfãs (criadas, mas sem navegação) e links externos não aparecem. Verifique se as páginas ausentes carregam corretamente em um navegador em <slug>.jamdesk.app.

Diagramas grandes, vídeos e imagens não otimizadas aumentam rapidamente o tamanho do PDF. Ative a Conversão automática de imagens para reduzir os bytes das imagens em 60-80%. Vídeos são renderizados como um quadro de pôster com um ícone de play, não como vídeo completo.

Próximos passos?

Triggering Builds

A exportação em PDF usa o build concluído mais recente. Inicie um manualmente ou a cada push.

Image Optimization

Converta PNG/JPG para WebP no momento do build para manter os PDFs pequenos.