Jamdesk Documentation logo

Build, Deploy e Analytics

Veja como os docs passam do git push ao site publicado: CLI, pipeline de build, hospedagem, domínios personalizados e analytics.

Você faz push para o GitHub (ou executa jamdesk deploy), o Jamdesk faz o build do site e as alterações entram no ar. Esse é o ciclo. As páginas desta seção abordam cada parte dele: a CLI que você usará diariamente, o que acontece durante um build, de onde seu site é servido e os analytics que o Jamdesk coleta em cada página sem scripts adicionais.

Build falhando? Solução de problemas de build associa mensagens de erro comuns às respectivas causas e soluções.

CLI

A CLI de código aberto permite visualizar a documentação localmente, validar a configuração, verificar links quebrados e fazer deploy.

Visão geral da CLI

Instale a CLI e aprenda os comandos principais

Autenticação

Login, armazenamento de tokens e gerenciamento de sessões

Deploy pela CLI

Como jamdesk deploy empacota, faz upload e executa o build da sua documentação

Corrigir links quebrados

jamdesk fix resolve links internos quebrados, exibindo primeiro uma prévia das alterações

Fluxo de build

Fluxo de deploy

Pushes do GitHub, deploys pela CLI, acompanhamento de status e novos builds manuais

Acionar builds

Automático após um push, manual pelo dashboard, além de debouncing e filas

Monitorar builds

Progresso em tempo real, fases do build e logs estruturados

Corrigir com IA

Revise e aplique correções sugeridas por IA no dashboard de build

Conversão automática de imagens

Conversão de PNG e JPG para WebP durante o build

Exportação para PDF

Exporte todo o site como um único PDF

Hospedagem e domínios

Seu site começa em yourproject.jamdesk.app. Quando estiver pronto, sirva-o pelo seu próprio domínio ou por um caminho /docs no site existente.

Visão geral do deploy

Subdomínio, domínio personalizado ou subcaminho: compare as opções de hospedagem

Ciclo de build e deploy

O pipeline completo do git push ao site publicado

Domínios personalizados

Configuração de DNS para servir a documentação pelo seu próprio domínio com SSL

Somente domínio personalizado

Impede que o subdomínio do Jamdesk responda diretamente

Subdomínios do Jamdesk

Regras de nomenclatura e como alterar seu subdomínio padrão

Hospedagem em subcaminho

Hospede em yoursite.com/docs em vez de usar um subdomínio separado

Guias da plataforma

Configurações testadas para fazer proxy de /docs pela sua infraestrutura existente.

AWS Route 53 e CloudFront

Configuração da distribuição e do origin

Cloudflare Workers

Configuração do Worker e roteamento do tráfego de /docs

Proxy reverso

nginx, Apache, Caddy, Traefik ou HAProxy

Vercel

Uma reescrita vercel.json com o marcador jd_proxy

Analytics e monitoramento

Visão geral dos analytics

Visualizações de página, fontes de tráfego e consultas de pesquisa sem scripts externos

Analytics do projeto

Comportamento dos visitantes no seu site, com foco na privacidade

Analytics de pesquisa

O que os leitores pesquisam e as lacunas de conteúdo reveladas por essas pesquisas

Aplicativo móvel

Status do build e analytics em qualquer lugar, com notificações push